Skip to content
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

docs: clarify the absence of the "Error: " prefix in Debug output #308

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify the absence of the "Error: " prefix in Debug output #308

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,12 +300,12 @@ pub use anyhow as format_err;
/// Failed to read instrs from ./path/to/instrs.json: No such file or directory (os error 2)
/// ```
///
/// The Debug format "{:?}" includes your backtrace if one was captured. Note
/// that this is the representation you get by default if you return an error
/// from `fn main` instead of printing it explicitly yourself.
/// The Debug format "{:?}" includes your backtrace if one was captured.
/// Note that the "Error: " prefix is not included unlike returning an error directly from `fn main`.
/// For more info, see the implementation of [std::process::Termination] for [std::result::Result].
///
/// ```console
/// Error: Failed to read instrs from ./path/to/instrs.json
/// Failed to read instrs from ./path/to/instrs.json
///
/// Caused by:
/// No such file or directory (os error 2)
Expand All @@ -314,7 +314,7 @@ pub use anyhow as format_err;
/// and if there is a backtrace available:
///
/// ```console
/// Error: Failed to read instrs from ./path/to/instrs.json
/// Failed to read instrs from ./path/to/instrs.json
///
/// Caused by:
/// No such file or directory (os error 2)
Expand Down