Fix: documentation of #step in Number and Char
#10966
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
straight-shoota
approved these changes
Jul 19, 2021
| @@ -122,6 +122,12 @@ struct Char | |||
| self - other | |||
| end | |||
|
|
|||
| # Performs a `#step` in the direction of the _limit_. For instance: | |||
There was a problem hiding this comment.
The external name of the parameter is to. Should we use that or the internal one? 🤔
Suggested change
| # Performs a `#step` in the direction of the _limit_. For instance: | |
| # Performs a `#step` in the direction of _to_. For instance: |
"limit" sounds better, and I suppose that's the entire reason for using an internal name. So it's probably fine as it is, just want to double check.
There was a problem hiding this comment.
Yeah, I also wonder about this and decided for limit but without being entirely convinced
straight-shoota
added
kind:bug
straight-shoota
pushed a commit
to straight-shoota/crystal
that referenced
this pull request
Jul 24, 2021
Merged
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.
As mentioned in a comment, the documentation got wrong
:dittofor the step methods inNumber. Here not only that is fixed, but also the documentation is improved and extended toChar.