Skip to content

Commit a3a4764

Browse files
committed
docs(derive): Specify Parser::update_from semantics
1 parent df165a2 commit a3a4764

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

clap_builder/src/derive.rs

+4
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ pub trait Parser: FromArgMatches + CommandFactory + Sized {
7373
}
7474

7575
/// Update from iterator, [exit][Error::exit] on error.
76+
///
77+
/// Unlike [`Parser::parse`], this works with an existing instance of `self`.
78+
/// The assumption is that all required fields are already provided and any [`Args`] or
79+
/// [`Subcommand`]s provided by the user will modify only what is specified.
7680
fn update_from<I, T>(&mut self, itr: I)
7781
where
7882
I: IntoIterator<Item = T>,

0 commit comments

Comments
 (0)