Skip to content

octocrab::Error: don't include unconditional backtrace in Display impl#824

Merged
XAMPPRocky merged 1 commit intoXAMPPRocky:mainfrom
lschuermann:dev/no-error-display-backtrace
Apr 27, 2026
Merged

octocrab::Error: don't include unconditional backtrace in Display impl#824
XAMPPRocky merged 1 commit intoXAMPPRocky:mainfrom
lschuermann:dev/no-error-display-backtrace

Conversation

@lschuermann
Copy link
Copy Markdown
Contributor

Users of this crate cannot currently get an error description without the backtrace included. This may be undesirable for a number of reasons, and is inconsistent with the examples in the snafu crate (whose Display implementations generally do not include a backtrace). Users who want a backtrace to be printed can still do so for an octocrab Error e by writing:

snafu::ErrorCompat::backtrace(&e)

This was requested as part of a pull request to a project using this crate: 0xB10C/github-metadata-backup#11 (comment)

Users of this crate cannot currently get an error description without
the backtrace included. This may be undesirable for a number of
reasons, and is inconsistent with the examples in the `snafu`
crate (whose Display implementations generally do not include a
backtrace). Users who want a backtrace to be printed can still do so
for an octocrab Error `e` by writing:

    snafu::ErrorCompat::backtrace(&e)
@lschuermann lschuermann changed the title error: don't include unconditional backtrace in Display impl octocrab::Error: don't include unconditional backtrace in Display impl Nov 11, 2025
@XAMPPRocky
Copy link
Copy Markdown
Owner

Thank you for your PR!

@XAMPPRocky XAMPPRocky merged commit 41f3b3f into XAMPPRocky:main Apr 27, 2026
20 checks passed
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.

2 participants