Skip to content

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

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

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

Conversation

@joshtrichards

@joshtrichardsjoshtrichards commented Apr 28, 2026

Copy link
Copy Markdown
Member

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.

@joshtrichardsjoshtrichards added this to the Nextcloud 34 milestone Apr 28, 2026
@joshtrichardsjoshtrichards 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 ownerApril 28, 2026 16:26
@joshtrichards
joshtrichards requested review from CarlSchwan, artonge, leftybournes and nfebe and removed request for a teamApril 28, 2026 16:26
@joshtrichardsjoshtrichards added the 3. to review Waiting for reviews label Apr 28, 2026
@artonge
artongeforce-pushed the jtr/docs-lock-LockContext-API branch from dc875b8 to e66b1f5CompareApril 30, 2026 17:41
joshtrichardsand 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
susnuxforce-pushed the jtr/docs-lock-LockContext-API branch from e66b1f5 to 7f96970CompareMay 3, 2026 10:02
@AndyScherzinger
AndyScherzinger merged commit 0f82477 into masterMay 5, 2026
255 of 271 checks passed
@AndyScherzinger
AndyScherzinger deleted the jtr/docs-lock-LockContext-API branch May 5, 2026 09:28
This was referenced May 5, 2026
This was referenced May 12, 2026
@nextcloud-botnextcloud-bot mentioned this pull request May 20, 2026
@nextcloud-botnextcloud-bot mentioned this pull request May 27, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3. to reviewWaiting for reviewsdeveloper experiencefeature: locking♻️ refactorRefactor 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

@joshtrichards@susnux@artonge@provokateurin@AndyScherzinger