Write better module-level and type-level docs for String #30146
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
| @@ -139,7 +324,7 @@ impl String { | |||
| /// // some bytes, in a vector | |||
| /// let sparkle_heart = vec![240, 159, 146, 150]; | |||
| /// | |||
| /// // We know these bytes are valid, so just use `unwrap()`. | |||
| /// // We know these bytes are valid, so we'll use `unwrap()`. | |||
There was a problem hiding this comment.
these two changes were made to bring this example in line with the module-level version, cc #28835
|
r? @brson (rust_highfive has picked a reviewer for you, use r? to override) |
| //! | ||
| //! The `String` type is the most common string type that has ownership over the | ||
| //! contents of the string. It has a close relationship with its borrowed | ||
| //! counterpoint, the primitive [`str`]. |
There was a problem hiding this comment.
s/counterpoint/counterpart/
steveklabnik
force-pushed
the
doc_string_intro
branch
3 times, most recently
from
8ccc806 to
85a896d
Compare
| //! length, and a capacity. The pointer points to an internal buffer `String` | ||
| //! uses to store its data. The length is the number of elements currently | ||
| //! stored in the buffer, and the capacity is the size of the buffer. As such, | ||
| //! the length will always be less than or equal to the capacity. |
There was a problem hiding this comment.
"elements" -> "bytes" and "size of the buffer in bytes" perhaps.
steveklabnik
force-pushed
the
doc_string_intro
branch
from
85a896d to
492f6fc
Compare
|
@brson updated to address the issues, other than the UTF-8 stuff. I think that's something that will have to come later. |
|
@bors r+ |
|
📌 Commit 492f6fc has been approved by |
| /// | ||
| /// This buffer is always stored on the heap. | ||
| /// | ||
| /// You can look at these with the [`as_ptr()`], [`len()`], and [`capacity()`] |
There was a problem hiding this comment.
This section is… pretty far away from the “these”. It should either be repeated what “these” are or paragraphs should be reorganised.
bors
added a commit
that referenced
this pull request
Dec 2, 2015
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.
Part of #29376