Correct doc mistakes #54
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
The doc comments implied that tryRecv and trySend do not block. That is incorrect. They do not block *waiting for data*. They *do* block trying to acquire the lock to the channel. Also some adjustments for better uniformity in the docs: - Messages renamed to items - Some doc comments were made more similar to one another in text style
ZoomRmc
suggested changes
Dec 15, 2023
There was a problem hiding this comment.
I'm not sure the total pruning the message term from the docs is for the good. This module implements the "message passing" synchronization primitive, people are surely looking for this.
Hmm fair, I think then I'd want to change all of "items" mentions to "message", the idea is just consistency. When I mention items I awaken the idea of what items is compared to messages and if they're the same, I'd want to avoid that, I'll fix it accordingly! |
Includes @ZoomRc's suggestions from PR nim-lang#54 but splits them up into smaller sentences to make them more digestable.
Used specific article "the" for sending messages as you know the mssage being sent. Used unspecific article "a" for receiving a message as you do not know what you receive.
ZoomRmc
approved these changes
Dec 16, 2023
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.
The doc comments implied that tryRecv and trySend do not block. That is incorrect.
They do not block waiting for data.
They do block trying to acquire the lock to the channel.
Also some adjustments for better uniformity in the docs:
@ZoomRmc Tried to include the changes you suggested in #53