updated docs

Sidney Douw · Sidney Douw · commit 77a9d42ec4f5 · 2022-10-27T11:40:20.000+02:00
diff --git a/git-index/src/access.rs b/git-index/src/access.rs
@@ -102,6 +102,8 @@ impl State {
     }
 
     /// Returns a boolean value indicating whether the index is sparse or not
+    ///
+    /// An index is set to be sparse either if it contains [Mode::DIR][Entry::Mode::DIR] entries or if the `sdir` extension is present
     pub fn is_sparse(&self) -> bool {
         self.is_sparse
     }

Original file line number	Diff line number	Diff line change
`@@ -102,6 +102,8 @@ impl State {`
`102`	`102`	`}`
`103`	`103`
`104`	`104`	`/// Returns a boolean value indicating whether the index is sparse or not`
	`105`	`+ ///`
	`106`	+ /// An index is set to be sparse either if it contains [Mode::DIR][Entry::Mode::DIR] entries or if the `sdir` extension is present
`105`	`107`	`pub fn is_sparse(&self) -> bool {`
`106`	`108`	`self.is_sparse`
`107`	`109`	`}`