1 files changed, 21 insertions, 1 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 02941c8..2fae25c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -161,6 +161,22 @@
 //!   # };
 //!   ```
 //!
+//! - If a field is both a source (named `source`, or has `#[source]` or
+//!   `#[from]` attribute) *and* is marked `#[backtrace]`, then the Error
+//!   trait's `backtrace()` method is forwarded to the source's backtrace.
+//!
+//!   ```rust
+//!   # const IGNORE: &str = stringify! {
+//!   #[derive(Error, Debug)]
+//!   pub enum MyError {
+//!       Io {
+//!           #[backtrace]
+//!           source: io::Error,
+//!       },
+//!   }
+//!   # };
+//!   ```
+//!
 //! - Errors may use `error(transparent)` to forward the source and Display
 //!   methods straight through to an underlying error without adding an
 //!   additional message. This would be appropriate for enums that need an
@@ -185,7 +201,11 @@
 //!
 //!   [`anyhow`]: https://github.com/dtolnay/anyhow
 
-#![allow(clippy::module_name_repetitions)]
+#![allow(
+    // Clippy bug: https://github.com/rust-lang/rust-clippy/issues/7421
+    clippy::doc_markdown,
+    clippy::module_name_repetitions,
+)]
 
 mod aserror;
 mod display;