Skip to content

Commit 0a1caeb

Browse files
committed
fix docs (#364)
1 parent 7cf3545 commit 0a1caeb

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

git-traverse/src/commit.rs

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,7 @@ pub mod ancestors {
111111
///
112112
/// * `find` - a way to lookup new object data during traversal by their ObjectId, writing their data into buffer and returning
113113
/// an iterator over commit tokens if the object is present and is a commit. Caching should be implemented within this function
114-
/// as needed. The return value is `Option<CommitIter>` which degenerates all error information. Not finding a commit should also
115-
/// be considered an errors as all objects in the commit graph should be present in the database. Hence [`Error::NotFound`] should
116-
/// be escalated into a more specific error if its encountered by the caller.
114+
/// as needed.
117115
/// * `state` - all state used for the traversal. If multiple traversals are performed, allocations can be minimized by reusing
118116
/// this state.
119117
/// * `tips`
@@ -135,9 +133,7 @@ pub mod ancestors {
135133
///
136134
/// * `find` - a way to lookup new object data during traversal by their ObjectId, writing their data into buffer and returning
137135
/// an iterator over commit tokens if the object is present and is a commit. Caching should be implemented within this function
138-
/// as needed. The return value is `Option<CommitIter>` which degenerates all error information. Not finding a commit should also
139-
/// be considered an errors as all objects in the commit graph should be present in the database. Hence [`Error::NotFound`] should
140-
/// be escalated into a more specific error if its encountered by the caller.
136+
/// as needed.
141137
/// * `state` - all state used for the traversal. If multiple traversals are performed, allocations can be minimized by reusing
142138
/// this state.
143139
/// * `tips`

0 commit comments

Comments
 (0)