Improve doc comment

diff --git a/cargo-miri/bin.rs b/cargo-miri/bin.rs
index d0ab82732427c75d0f9d08722a4a44438821020c..8d2065c8eeb4f36d9fa2c9f8190e94f011eb74d2 100644 (file)
--- a/cargo-miri/bin.rs
+++ b/cargo-miri/bin.rs
@@ -113,7 +113,7 @@ fn has_arg_flag(name: &str) -> bool {
 }
 
 /// Yields all values of command line flag `name` as `Ok(arg)`, and all other arguments except
-/// the flag as `Err(arg)`.
+/// the flag as `Err(arg)`. (The flag `name` itself is not yielded at all, only its values are.)
 struct ArgSplitFlagValue<'a, I> {
     args: TakeWhile<I, fn(&String) -> bool>,
     name: &'a str,