improve documentation of gix_index::entry::Stat::matches

pascalkuthe · pascalkuthe · commit 1e19760ad327 · 2023-04-13T15:19:53.000+02:00
diff --git a/gix-index/src/entry/stat.rs b/gix-index/src/entry/stat.rs
@@ -27,7 +27,12 @@ impl Stat {
         }
     }
 
-    /// Compares stat information given a set of git setting
+    /// Compares the stat information of two index entries. Intuitively this is
+    /// basically equivalent to `self == other`. However there a lot of nobs in
+    /// git that tweak whether certain stat information is used when checking
+    /// equality, see [`gix_index::entry::stat::Options`]. This function
+    /// respects those options while performing the stat comparison (and may
+    /// therefore ignore some fields)
     pub fn matches(
         &self,
         other: &Self,

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,12 @@ impl Stat {`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`
`30`		`- /// Compares stat information given a set of git setting`
	`30`	`+ /// Compares the stat information of two index entries. Intuitively this is`
	`31`	+ /// basically equivalent to `self == other`. However there a lot of nobs in
	`32`	`+ /// git that tweak whether certain stat information is used when checking`
	`33`	+ /// equality, see [`gix_index::entry::stat::Options`]. This function
	`34`	`+ /// respects those options while performing the stat comparison (and may`
	`35`	`+ /// therefore ignore some fields)`
`31`	`36`	`pub fn matches(`
`32`	`37`	`&self,`
`33`	`38`	`other: &Self,`