search

shepmaster / snafu

Easily assign underlying errors into domain-specific errors while adding context
https://docs.rs/snafu/
Apache License 2.0
1.39k stars 60 forks source link

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

Open casey opened 2 months ago

casey commented 2 months ago

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.