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

Document using Option<Backtrace> more prominently in docs #458

Open
casey opened this issue Jul 2, 2024 · 0 comments
Open

Document using Option<Backtrace> more prominently in docs #458

casey opened this issue Jul 2, 2024 · 0 comments

Comments

@casey
Copy link

casey commented Jul 2, 2024

I missed the change a few versions ago where a Backtrace field is now unconditional, and an Option<Backtrace> only captures a backtrace if RUST_BACKTRACE or RUST_LIB_BACKTRACE is set.

I was a bit confused that backtraces were always being captured, read the docs, and eventually read that I should use Option<Backtrace> in the changelog notes.

I think this could be documented more prominently in the docs, maybe in the Snafu macro docs.

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

No branches or pull requests

1 participant