Try to clarify split docs
#26634
Merged
Try to clarify split docs
#26634
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 description of the options was confusing. We might also want change the `keep` option to something more descriptive, like `keepempty`
base/strings/util.jl
Outdated
| @@ -239,17 +239,20 @@ function rpad( | |||
| end | |||
|
|
|||
| """ | |||
| split(s::AbstractString; limit::Integer=0, keep::Bool=false) | |||
| split(s::AbstractString, [chars]; limit::Integer=0, keep::Bool=true) | |||
There was a problem hiding this comment.
The brackets around chars can be removed with this clarification.
ararslan
reviewed
Mar 28, 2018
base/strings/util.jl
Outdated
| The optional keyword arguments are: | ||
| - `limit`: the maximum size of the result. `limit=0` implies no maximum (default) | ||
| - `keep`: whether empty fields should be kept in the result. Default is `false` without | ||
| `chars` argument, `true` with `chars. |
JeffBezanson
approved these changes
Mar 28, 2018
I think this would be good. I was confused by this the other week since I just assumed that |
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 description of the options was confusing.
We might also want change the
keepoption to something more descriptive, likekeepempty