[3.x] Bind Semaphore.try_wait()
#60502
Merged
Conversation
This file contains 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
akien-mga
reviewed
Apr 25, 2022
doc/classes/Semaphore.xml
Outdated
| @@ -13,13 +13,19 @@ | |||
| <method name="post"> | |||
| <return type="int" enum="Error" /> | |||
| <description> | |||
| Lowers the [Semaphore], allowing one more thread in. Returns [constant OK] on success, [constant ERR_BUSY] otherwise. | |||
| Lowers the [Semaphore], allowing one more thread in. Always return [constant OK] for backwards compatibility. | |||
There was a problem hiding this comment.
For this and wait, since it mentions backwards compatibility, it raises the question of what's the "new" way to use this API where these return values are no longer relevant.
There was a problem hiding this comment.
The implementation of these two methods changed, so they always succeed. There is no need to check for return value now.
master changed their return type to void.
There was a problem hiding this comment.
Maybe the wording could be changed to something like, "This method internals' can't possibly fail, but an error code is returned for back compat, which will always be OK".
akien-mga
approved these changes
Apr 25, 2022
|
Thanks! |
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.
Also updates the documentation of
wait()andpost(), as they always returnOKnow.