Clarify docs for LoadOrCompute and LoadOrTryCompute
#154
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 existing docs seem to be derived from `LoadOrStore`, and reference what happens when a value is "stored". It would be clearer if the docs used consistent terminology and discussed what happens when a value is "computed".
jjlin
commented
Jan 27, 2025
| // and, if success, returns the computed value. The loaded result is true | ||
| // if the value was loaded, false if stored. If the compute attempt was | ||
| // cancelled, a nil will be returned. | ||
| // LoadOrCompute returns the existing value for the key if present. |
There was a problem hiding this comment.
I also reordered LoadOrCompute and LoadOrTryCompute to make the order consistent between map.go and mapof.go. There are no actual code changes in this PR.
puzpuzpuz
added
documentation
puzpuzpuz
approved these changes
Jan 27, 2025
|
Thanks for the contribution! |
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 existing docs seem to be derived from
LoadOrStore, and reference what happens when a value is "stored". It would be clearer if the docs used consistent terminology and discussed what happens when a value is "computed".