Fix mistakes in MVar documentation #1087
Open
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
eregon
reviewed
Jul 5, 2025
| @@ -66,7 +66,7 @@ There are a few guidelines which we follow when adding features. Consider that s | |||
|
|
|||
| #### Write Documentation | |||
|
|
|||
| Document any external behavior in the [README](README.md). | |||
| Document any external behavior in the [README](/README.md). | |||
There was a problem hiding this comment.
Suggested change
| Document any external behavior in the [README](/README.md). | |
| Document any external behavior in the [README](../README.md). |
/README.md doesn't seem to work, on GitHub at least, same below of course
eregon
reviewed
Jul 5, 2025
| # be set to limit the time spent blocked, in which case it returns `TIMEOUT` | ||
| # if the time is exceeded. | ||
| # @return [Object] the transformed value, or `TIMEOUT` | ||
| # @return [Object] the pre-transform value, or `TIMEOUT` |
There was a problem hiding this comment.
I wonder if instead the code should return the transformed value.
But looking at
concurrent-ruby/spec/concurrent/mvar_spec.rb
Lines 180 to 183 in c8f0bae
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.
Fixes a couple of mistakes in documentation:
#modify's documentation very incorrectly said that it returns modified value, when that's not the case;#mutateinstead of#modify;Additionally, links to README and CHANGELOG are fixed in contributing guidelines, previously they linked to non-existent files.