[DOC] Refine String#split documentation
#12126
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
jeremyevans
approved these changes
Nov 20, 2024
There was a problem hiding this comment.
This looks good, thank you for working on this. I think it would good for @BurdetteLamar to review as well.
I found one spelling issue, which should be fixed before merging. The other comment is just a suggestion, you can merge without it if you don't think it would be helpful.
0b91f40 to
f576616
Compare
The current documentation for `String#split` is missing some
details about its behavior.
* Removing leading whitespace by `split(' ')`
* Splitting into indivisual characters by `split('')`
Additionally, the first argument `field_sep` and the second argument
`limit` operate independently. Explaining them separately would enhance
readability.
f576616 to
7f5f7c4
Compare
|
Thanks, @everyone, for calling this to my attention. I'd like to address the comments here about examples, but in a new PR, after this is merged. (I like to think I'm good with the docs, but I'm definitely not good with the details of reviewing on GH.) |
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 current documentation for
String#splitis missing some details about its behavior.split(' ')split('')Additionally, the first argument
field_sepand the second argumentlimitoperate independently. Explaining them separately would enhance readability.