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

epage · web-flow · commit fdbbf66e77c8 · 2025-03-03T20:43:48.000-06:00
document `clap::Error::insert` a bit better
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> {

Original file line number	Diff line number	Diff line change
`@@ -195,6 +195,8 @@ impl<F: ErrorFormatter> Error<F> {`
`195`	`195`	`}`
`196`	`196`
`197`	`197`	`/// Insert a piece of context`
	`198`	`+ ///`
	`199`	+ /// If this `ContextKind` is already present, its value is replaced and the old value is returned.
`198`	`200`	`#[inline(never)]`
`199`	`201`	`#[cfg(feature = "error-context")]`
`200`	`202`	`pub fn insert(&mut self, kind: ContextKind, value: ContextValue) -> Option<ContextValue> {`