Improve doc comment

hyd-dev · hyd-dev · commit 08236912a70c · 2021-06-27T23:10:09.000+08:00
diff --git 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,

Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ fn has_arg_flag(name: &str) -> bool {`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	/// Yields all values of command line flag `name` as `Ok(arg)`, and all other arguments except
`116`		-/// the flag as `Err(arg)`.
	`116`	+/// the flag as `Err(arg)`. (The flag `name` itself is not yielded at all, only its values are.)
`117`	`117`	`struct ArgSplitFlagValue<'a, I> {`
`118`	`118`	`args: TakeWhile<I, fn(&String) -> bool>,`
`119`	`119`	`name: &'a str,`