Skip to content

Commit 2d7956a

Browse files
committed
[actor #173] fix docs
1 parent 08a1849 commit 2d7956a

File tree

6 files changed

+8
-8
lines changed

6 files changed

+8
-8
lines changed

git-object/src/commit.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use bstr::{BStr, ByteSlice};
22

33
use crate::immutable;
44

5-
/// An iterator over extra headers in [owned][crate::mutable::Commit] and [borrowed][signature_ref::Commit] commits.
5+
/// An iterator over extra headers in [owned][crate::mutable::Commit] and [borrowed][immutable::Commit] commits.
66
pub struct ExtraHeaders<I> {
77
inner: I,
88
}

git-object/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! This crate provides types for [read-only git objects][signature_ref::Object] backed by bytes provided in git's serialization format
1+
//! This crate provides types for [read-only git objects][immutable::Object] backed by bytes provided in git's serialization format
22
//! as well as [mutable versions][mutable::Object] of these. The latter can be serialized into git's serialization format for objects.
33
#![forbid(unsafe_code)]
44
#![deny(rust_2018_idioms, missing_docs)]

git-object/src/mutable/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
//! Mutable objects with each field being separately allocated and changeable.
22
//!
33
//! Mutable objects are Commits, Trees, Blobs and Tags that can be changed and serialized.
4-
//! They either created using object [construction][Object] or by [deserializing existing objects][crate::signature_ref::Object::from_bytes()]
5-
//! and converting these [into mutable copies][crate::signature_ref::Object::into_mutable()] for adjustments.
4+
//! They either created using object [construction][Object] or by [deserializing existing objects][crate::immutable::Object::from_bytes()]
5+
//! and converting these [into mutable copies][crate::immutable::Object::into_mutable()] for adjustments.
66
77
const NL: &[u8; 1] = b"\n";
88
const SPACE: &[u8; 1] = b" ";

git-object/src/types.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ impl fmt::Display for Kind {
5656
pub mod tree {
5757
/// The mode of items storable in a tree, similar to the file mode on a unix file system.
5858
///
59-
/// Used in [mutable::Entry][crate::mutable::tree::Entry] and [signature_ref::Entry][crate::signature_ref::tree::Entry].
59+
/// Used in [mutable::Entry][crate::mutable::tree::Entry] and [signature_ref::Entry][crate::immutable::tree::Entry].
6060
#[derive(Clone, Copy, PartialEq, Eq, Debug, Ord, PartialOrd, Hash)]
6161
#[repr(u16)]
6262
#[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]

git-pack/src/data/object.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ impl<'a> Object<'a> {
2222
pack_location: None,
2323
}
2424
}
25-
/// Decodes the data in the backing slice into a [`git_object::signature_ref::Object`], allowing to access all of its data
25+
/// Decodes the data in the backing slice into a [`git_object::immutable::Object`], allowing to access all of its data
2626
/// conveniently. The cost of parsing an object is negligible.
2727
///
2828
/// **Note** that [mutable, decoded objects][git_object::mutable::Object] can be created from a [`crate::data::Object`]
29-
/// using [`git_object::signature_ref::Object::into_mutable()`].
29+
/// using [`git_object::immutable::Object::into_mutable()`].
3030
pub fn decode(&self) -> Result<immutable::Object<'a>, immutable::object::decode::Error> {
3131
Ok(match self.kind {
3232
git_object::Kind::Tree => immutable::Object::Tree(immutable::Tree::from_bytes(self.data)?),

git-traverse/src/tree/recorder.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use git_object::{
99
use crate::tree::{visit, visit::Action};
1010

1111
/// An owned entry as observed by a call to [`visit_(tree|nontree)(…)`][visit::Visit::visit_tree()], enhanced with the full path to it.
12-
/// Otherwise similar to [`signature_ref::tree::Entry`][git_object::signature_ref::tree::Entry].
12+
/// Otherwise similar to [`signature_ref::tree::Entry`][git_object::immutable::tree::Entry].
1313
#[derive(Clone, Debug, PartialEq, Eq)]
1414
pub struct Entry {
1515
/// The kind of entry, similar to entries in a unix directory tree.

0 commit comments

Comments
 (0)