Bug 508390 - Documentation for `Document.lock` does not make sense; references non-existent `barrierLock`
Summary: Documentation for `Document.lock` does not make sense; references non-existen...
Status: REPORTED
Alias: None
Product: krita
Classification: Applications
Component: Scripting (other bugs)
Version First Reported In: 5.2.9
Platform: Other Linux
: NOR normal
Target Milestone: ---
Assignee: Krita Bugs
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2025-08-17 15:59 UTC by Sabrina Jewson
Modified: 2025-08-17 15:59 UTC (History)
0 users

See Also:
Latest Commit:
Version Fixed/Implemented In:
Sentry Crash Report:

Attachments
Add an attachment

Note You need to log in before you can comment on or make changes to this bug.
Description Sabrina Jewson 2025-08-17 15:59:40 UTC 
SUMMARY

The documentation for [`Document.lock`][1] says the following:

> In all other cases, please use barrierLock() instead!

However `barrierLock()` does not exist, although `tryBarrierLock()` does. Despite that, if you look at the source code of the method, it in fact calls `barrierLock()` internally.

[1]: https://api.kde.org/krita/html/classDocument.html