Skip to content

Commit

Permalink
fix docs (#279)
Browse files Browse the repository at this point in the history
  • Loading branch information
Byron committed Dec 31, 2021
1 parent 2fc6751 commit b61a920
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions git-chunk/src/file/write.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,14 @@ pub use write_chunk::Chunk;
/// Writing
impl Index {
/// Create a new index whose sole purpose is to be receiving chunks using [`plan_chunk()`][Index::plan_chunk()] and to be written to
/// an output using [`write_to()`][Index::into_write()]
/// an output using [`into_write()`][Index::into_write()]
pub fn for_writing() -> Self {
Index {
will_write: true,
chunks: Vec::new(),
}
}
/// Plan to write a new chunk as part of the index when [`write_to()`][Index::write_to()] is called.
/// Plan to write a new chunk as part of the index when [`into_write()`][Index::into_write()] is called.
pub fn plan_chunk(&mut self, chunk: crate::Id, exact_size_on_disk: u64) {
assert!(self.will_write, "BUG: create the index with `for_writing()`");
assert!(
Expand Down
2 changes: 1 addition & 1 deletion git-repository/src/easy/object/errors.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
///
pub mod conversion {

/// The error returned by [`easy::Object::try_to_()`][crate::easy::Object::try_to_commit()].
/// The error returned by [`easy::Object::try_to_()`][crate::easy::Object::try_to_commit_ref()].
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
Expand Down
2 changes: 1 addition & 1 deletion git-repository/src/easy/object/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ impl<'repo> Object<'repo> {
})
}

/// Obtain a an iterator over commit tokens like in [`to_commit_iter()`][Object::try_to_commit_iter()].
/// Obtain a an iterator over commit tokens like in [`to_commit_iter()`][Object::try_to_commit_ref_iter()].
///
/// # Panic
///
Expand Down

0 comments on commit b61a920

Please sign in to comment.