Improve function docs for Repository::tag_foreach

cyqsimon · cyqsimon · commit 4d19f248b01c · 2025-10-19T21:09:01.000+08:00
diff --git a/src/repo.rs b/src/repo.rs
@@ -2043,8 +2043,10 @@ impl Repository {
         }
     }
 
-    /// iterate over all tags calling `cb` on each.
-    /// the callback is provided the tag id and name
+    /// Iterate over all tags, calling the callback `cb` on each.
+    /// The arguments of `cb` are the tag id and name, in this order.
+    ///
+    /// Returning `false` from `cb` causes the iteration to break early.
     pub fn tag_foreach<T>(&self, cb: T) -> Result<(), Error>
     where
         T: FnMut(Oid, &[u8]) -> bool,

Original file line number	Diff line number	Diff line change
`@@ -2043,8 +2043,10 @@ impl Repository {`
`2043`	`2043`	`}`
`2044`	`2044`	`}`
`2045`	`2045`
`2046`		- /// iterate over all tags calling `cb` on each.
`2047`		`- /// the callback is provided the tag id and name`
	`2046`	+ /// Iterate over all tags, calling the callback `cb` on each.
	`2047`	+ /// The arguments of `cb` are the tag id and name, in this order.
	`2048`	`+ ///`
	`2049`	+ /// Returning `false` from `cb` causes the iteration to break early.
`2048`	`2050`	`pub fn tag_foreach<T>(&self, cb: T) -> Result<(), Error>`
`2049`	`2051`	`where`
`2050`	`2052`	`T: FnMut(Oid, &[u8]) -> bool,`