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.

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

fix(docs): enclose inline code in backticks #170

Merged
merged 3 commits into from
Apr 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion eyre/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ impl Report {

/// Create a new error object from a printable error message.
///
/// If the argument implements std::error::Error, prefer `Report::new`
/// If the argument implements `std::error::Error`, prefer [`Report::new`]
/// instead which preserves the underlying error's cause chain and
/// backtrace. If the argument may or may not implement std::error::Error
/// now or in the future, use `eyre!(err)` which handles either way
Expand Down
14 changes: 7 additions & 7 deletions eyre/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -417,22 +417,22 @@ pub use WrapErr as Context;
///
/// # Display representations
///
/// When you print an error object using "{}" or to_string(), only the outermost underlying error
/// is printed, not any of the lower level causes. This is exactly as if you had called the Display
/// impl of the error from which you constructed your eyre::Report.
/// When you print an error object using `"{}"` or `to_string()`, only the outermost underlying error
/// is printed, not any of the lower level causes. This is exactly as if you had called the `Display`
/// implementation of the error from which you constructed your `eyre::Report`.
///
/// ```console
/// Failed to read instrs from ./path/to/instrs.json
/// ```
///
/// To print causes as well using eyre's default formatting of causes, use the
/// alternate selector "{:#}".
/// alternate selector `"{:#}"`.
///
/// ```console
/// 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
/// 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.
///
Expand All @@ -458,7 +458,7 @@ pub use WrapErr as Context;
/// 7: _start
/// ```
///
/// To see a conventional struct-style Debug representation, use "{:#?}".
/// To see a conventional struct-style Debug representation, use `"{:#?}"`.
///
/// ```console
/// Error {
Expand Down Expand Up @@ -1271,7 +1271,7 @@ pub trait ContextCompat<T>: context::private::Sealed {
F: FnOnce() -> D;
}

/// Equivalent to Ok::<_, eyre::Error>(value).
/// Equivalent to `Ok::<_, eyre::Error>(value)`.
///
/// This simplifies creation of an eyre::Result in places where type inference
/// cannot deduce the `E` type of the result &mdash; without needing to write
Expand Down
Loading