Skip to content

Updated the docs for Error::description #37189

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.

Sign up for GitHub

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
bors merged 3 commits into from
Oct 18, 2016
Merged

Updated the docs for Error::description #37189

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1b50ad
Updated the docs for Error::description
omern1 Oct 15, 2016
5758372
Corrected broken markdown link
omern1 Oct 15, 2016
16b8957
Fixed typo
omern1 Oct 15, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/libstd/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,11 @@ use string;
pub trait Error: Debug + Display {
/// A short description of the error.
///
/// The description should not contain newlines or sentence-ending
/// punctuation, to facilitate embedding in larger user-facing
/// strings.
/// The description should only be used for a simple message.
/// It should not contain newlines or sentence-ending punctuation,
/// to facilitate embedding in larger user-facing strings.
/// For showing formatted error messages with more information see
/// (Display)[https://doc.rust-lang.org/std/fmt/trait.Display.html].
Copy link
Contributor

@killercup killercup Oct 15, 2016

Choose a reason for hiding this comment

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

Markdown links work the other way around: [text](url).

Copy link
Contributor Author

@omern1 omern1 Oct 15, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

Done, thanks.

///
/// # Examples
///
Expand Down