string doc clarifications #26259
Closed
string doc clarifications #26259
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
Clarify that `firstindex(str)` should always be `1` for any `AbstractString`, as mentioned by @StefanKarpinski [here](#26133 (comment)). Also reference `prevind` and `eachindex`. Also introduce the "code unit" terminology and mention the `codeunit` functions.
stevengj
added
docs
|
@StefanKarpinski, I noticed this old doc PR and updated it. Is it still merge-worthy? |
|
Yes, definitely an improvement! I will look into the errors and get this merged. |
|
The doctest error is confusing to me; is there a missing backtick somewhere or something that is screwing up the parsing? |
|
Not sure, I've posted the error output to Slack on the #documentation channel; hopefully someone there can help out. I've also locally rebased this on top of master for clarity. |
fredrikekre
reviewed
Jan 10, 2019
| 7 | ||
| 10 | ||
| 11 | ||
| ``` |
There was a problem hiding this comment.
One extra leading space on this and the lines above.
|
Squashed, rebased version with an additional clarification here: #30682. I've also fixed the leading space and gotten the docs to build locally. |
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.
Clarify that
firstindex(str)should always be1for anyAbstractString, as mentioned by @StefanKarpinski here.Also reference
previndandeachindex.Also introduce the "code unit" terminology and mention the
codeunitfunctions.