Clarify some Docstrings #10
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
silvenac
approved these changes
Dec 20, 2022
dfinkel
approved these changes
Dec 20, 2022
| @@ -252,7 +254,7 @@ func (f *Clock) removeWaiter(ch chan struct{}, abort bool) { | |||
|
|
|||
| // SleepUntil blocks until either ctx expires or until arrives. | |||
| // Return value is false if context-cancellation/expiry prompted an | |||
| // early return | |||
| // early return. | |||
There was a problem hiding this comment.
Hmm, I don't have a problem with adding a period here, but we should be consistent in the other doc-comments. (It appears that the others that were edited are currently missing periods)
There was a problem hiding this comment.
Sure -- I've gone though and fixed all the docblocks to include periods at the end (I'd say most of them did to begin with).
The "Await" methods return when you get exactly the number of sleepers you're waiting for (not just more than that). Also, standardize sentence endings in all docblocks.
sergiosalvatore
force-pushed
the
docblock-update
branch
from
3a7d3d8 to
30149a6
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# 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 "Await" methods return when you get exactly the number of sleepers you're waiting for (not just more than that).