[Console] Add doc about lockableTrait #19697
Merged
Conversation
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
1fc1542 to
e07f55c
Compare
|
Why do I get |
console/lockable_trait.rst
Outdated
| @@ -43,4 +43,23 @@ that adds two convenient methods to lock and release commands:: | |||
| } | |||
| } | |||
|
|
|||
| By default, the LockableTrait will use the ``FlockStore``, or the ``SemaphoreStore`` if available, | |||
There was a problem hiding this comment.
This part is not fully clear to me:
will use the ``FlockStore``, or the ``SemaphoreStore`` if available [...]I propose to reword it to better explain which of the two stores will be tried first:
The LockableTrait will use the ``SemaphoreStore`` if available and will default
to ``FlockStore`` otherwise. You can override this behavior [...]There was a problem hiding this comment.
Thanks for the feedback, it's changed.
|
Vincent, you can ignore the code block error. It's a false positive that will be fixed when we update the code in that linter. Thanks. |
javiereguiluz
approved these changes
Mar 27, 2024
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.
Closes #19688