Skip to content

docs(lock): clarify LockContext docs and modernize implementation#59980

Merged
AndyScherzinger merged 2 commits intomasterfrom
jtr/docs-lock-LockContext-API
May 5, 2026
Merged

docs(lock): clarify LockContext docs and modernize implementation#59980
AndyScherzinger merged 2 commits intomasterfrom
jtr/docs-lock-LockContext-API

Conversation

@joshtrichards
Copy link
Copy Markdown
Member

@joshtrichards joshtrichards commented Apr 28, 2026

Summary

Improve LockContext documentation and make the implementation more concise.

Changes

  • clarify the class docblock and constructor parameter docs
  • document getType(), getOwner(), and __toString() more clearly
  • switch to constructor property promotion
  • mark properties as readonly
  • simplify __toString() using match and sprintf()

Notes

This is a documentation/cleanup change only and is not intended to change lock behavior.1

Checklist

AI (if applicable)

  • The content of this PR was partly or fully generated using AI

Footnotes

  1. Technically I did drop an extra space in the __toString() output.

@joshtrichards joshtrichards added this to the Nextcloud 34 milestone Apr 28, 2026
@joshtrichards joshtrichards added feature: locking developer experience ♻️ refactor Refactor code (not a bug fix, not a feature just refactoring) labels Apr 28, 2026
@joshtrichards joshtrichards marked this pull request as ready for review April 28, 2026 16:26
@joshtrichards joshtrichards requested a review from a team as a code owner April 28, 2026 16:26
@joshtrichards joshtrichards requested review from CarlSchwan, artonge, leftybournes and nfebe and removed request for a team April 28, 2026 16:26
@joshtrichards joshtrichards added the 3. to review Waiting for reviews label Apr 28, 2026
@provokateurin provokateurin enabled auto-merge April 29, 2026 11:44
@artonge artonge force-pushed the jtr/docs-lock-LockContext-API branch from dc875b8 to e66b1f5 Compare April 30, 2026 17:41
joshtrichards and others added 2 commits May 3, 2026 12:00
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
@susnux susnux force-pushed the jtr/docs-lock-LockContext-API branch from e66b1f5 to 7f96970 Compare May 3, 2026 10:02
@AndyScherzinger AndyScherzinger disabled auto-merge May 5, 2026 09:28
@AndyScherzinger AndyScherzinger merged commit 0f82477 into master May 5, 2026
255 of 271 checks passed
@AndyScherzinger AndyScherzinger deleted the jtr/docs-lock-LockContext-API branch May 5, 2026 09:28
@nextcloud-bot nextcloud-bot mentioned this pull request May 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3. to review Waiting for reviews developer experience feature: locking ♻️ refactor Refactor code (not a bug fix, not a feature just refactoring)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants