Merge pull request #5938 from ilyagr/error-insert-docs

document `clap::Error::insert` a bit better
clap-rs · Mar 4, 2025 · fdbbf66 · fdbbf66
2 parents 94c774b + b86dc51
commit fdbbf66
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/clap_builder/src/error/mod.rs b/clap_builder/src/error/mod.rs
@@ -195,6 +195,8 @@ impl<F: ErrorFormatter> Error<F> {
     }
 
     /// Insert a piece of context
+    ///
+    /// If this `ContextKind` is already present, its value is replaced and the old value is returned.
     #[inline(never)]
     #[cfg(feature = "error-context")]
     pub fn insert(&mut self, kind: ContextKind, value: ContextValue) -> Option<ContextValue> {