docs(lock): clarify ILockManager API documentation#59984
Open
joshtrichards wants to merge 3 commits intomasterfrom
Open
docs(lock): clarify ILockManager API documentation#59984joshtrichards wants to merge 3 commits intomasterfrom
joshtrichards wants to merge 3 commits intomasterfrom
Conversation
Signed-off-by: Josh <josh.t.richards@gmail.com>
LockManager::registerLazyLockProvider() checks for both eager and lazy, but the older registerLockProvider() did not. Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
CarlSchwan
approved these changes
Apr 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improve the
ILockManagerdocumentation and also fix a presumed bug in the underlyingregisterLockProvider()implementation.Changes
ILockManagerregisterLazyLockProvider()throwingPreConditionNotMetExceptionwhen a provider is already registeredrunInScope()throwingPreConditionNotMetExceptionwhen a scope is already activegetLockInScope()docs to reflect that it returnsnullwhen no scope is active instead of throwingisLockProviderAvailable()checks current availability and may attempt lazy provider resolutionregisterLockProvider()behavior with the documented single-provider registration contract by also rejecting previously registered lazy providersNotes
This change is intended to improve API clarity and keep the public interface documentation in sync with the implementation. No functional behavior changes are intended beyond the consistency fix in
registerLockProvider().Checklist
3. to review, feature component)stable32)AI (if applicable)