Improve documentation of Array#[Range] #10243
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
|
There are also |
WhereIsX
reviewed
Jan 19, 2021
WhereIsX
reviewed
Jan 19, 2021
WhereIsX
reviewed
Jan 21, 2021
HertzDevil
reviewed
Feb 9, 2021
Co-authored-by: Quinton Miller <nicetas.c@gmail.com>
|
|
HertzDevil
reviewed
May 27, 2021
HertzDevil
reviewed
May 27, 2021
|
@HertzDevil Looks like I had that already fixed but failed to push the changes. 🙈 |
oprypin
reviewed
May 31, 2021
src/string.cr
Outdated
| self[*Indexable.range_to_index_and_count(range, size) || raise IndexError.new] | ||
| end | ||
|
|
||
| # Like `#[Range]`, but returns `nil` if the range's start is out of bounds. | ||
| # Like `#[Range]`, but returns `nil` if `range.begin` is out of range. |
There was a problem hiding this comment.
This #[Range] syntax is really confusing and it is not recognized by the doc generator.
#[](Range) would be recognized, though.
Same for #[](Int, Int).
I realize this is pre-existing, but on the other hand, this PR is about improving documentation.
oprypin
approved these changes
May 31, 2021
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.
Resolves #10222
This is only a draft for now, please review the wording for improvements.
I'll then copy appropriate documentation to
String#[Range].