Skip to content

Document the Error types in std::string #30124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 1, 2015

Conversation

steveklabnik
Copy link
Member

Part of #29376

@rust-highfive
Copy link
Contributor

r? @aturon

(rust_highfive has picked a reviewer for you, use r? to override)

@@ -36,7 +36,41 @@ pub struct String {
vec: Vec<u8>,
}

/// A possible error value from the `String::from_utf8` function.
/// A possible error value when converting a `String` from a UTF8 byte vector.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/UTF8/UTF-8/

@@ -337,8 +390,8 @@ impl String {
///
/// ```
/// // 𝄞music
/// let mut v = &mut [0xD834, 0xDD1E, 0x006d, 0x0075,
/// 0x0073, 0x0069, 0x0063];
/// let v = &mut [0xD834, 0xDD1E, 0x006d, 0x0075,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in these examples the mut here can be dropped as well (may have just bee included by accident long ago)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@alexcrichton
Copy link
Member

@bors: r+ 8f6b30ea455d41660a544876069a1fdae9ce8f45

@bors
Copy link
Collaborator

bors commented Dec 1, 2015

⌛ Testing commit 8f6b30e with merge 0cf64b8...

@bors
Copy link
Collaborator

bors commented Dec 1, 2015

💔 Test failed - auto-mac-64-nopt-t

@steveklabnik
Copy link
Member Author

@bors: r=alexcrichton

@bors
Copy link
Collaborator

bors commented Dec 1, 2015

📌 Commit 546e8f9 has been approved by alexcrichton

@bors
Copy link
Collaborator

bors commented Dec 1, 2015

⌛ Testing commit 546e8f9 with merge ed121aa...

bors added a commit that referenced this pull request Dec 1, 2015
@bors bors merged commit 546e8f9 into rust-lang:master Dec 1, 2015
@steveklabnik steveklabnik deleted the doc_string_errors branch June 19, 2016 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants