fix docs

Sebastian Thiel committed 4 years ago

Commit 34e899a1 parent f256f8f2 files · +2 −2Browse files

Unified · Split

2 files

git-diff/src/tree/changes.rs +1 −1
git-traverse/src/tree/breadthfirst.rs +1 −1

git-diff/src/tree/changes.rs+1−1

@@ -28,7 +28,7 @@ impl<'a> tree::Changes<'a> { · 27 unmodified lines
28	/// * The `state` maybe owned or mutably borrowed to allow reuses allocated data structures through multiple runs.	28	/// * The `state` maybe owned or mutably borrowed to allow reuses allocated data structures through multiple runs.
29	/// * `locate` is a function `f(object_id, &mut buffer) -> Option<TreeIter>` to return a `TreeIter` for the given object id backing	29	/// * `locate` is a function `f(object_id, &mut buffer) -> Option<TreeIter>` to return a `TreeIter` for the given object id backing
30	/// its data in the given buffer. Returning `None` is unexpected as these trees are obtained during iteration, and in a typical	30	/// its data in the given buffer. Returning `None` is unexpected as these trees are obtained during iteration, and in a typical
31	/// database errors are not expected either which is why the error case is omitted. To allow proper error reporting, [`Error::NotFound`]	31	/// database errors are not expected either which is why the error case is omitted. To allow proper error reporting, [`Error::FindExisting`]
32	/// should be converted into a more telling error.	32	/// should be converted into a more telling error.
33	/// * `delegate` will receive the computed changes, see the [`Visit`][`tree::Visit`] trait for more information on what to expect.	33	/// * `delegate` will receive the computed changes, see the [`Visit`][`tree::Visit`] trait for more information on what to expect.
34	///	34	///

git-traverse/src/tree/breadthfirst.rs+1−1

@@ -2,7 +2,7 @@ use std::collections::VecDeque; · 1 unmodified line
2		2
3	use git_hash::ObjectId;	3	use git_hash::ObjectId;
4		4
5	/// The error is part of the item returned by the [`traverse()`] function.	5	/// The error is part of the item returned by the [`traverse()`][impl_::traverse()] function.
6	#[derive(Debug, thiserror::Error)]	6	#[derive(Debug, thiserror::Error)]
7	#[allow(missing_docs)]	7	#[allow(missing_docs)]
8	pub enum Error {	8	pub enum Error {