[object #177] fix docs

Author: Byron

git-actor/src/lib.rs

@@ -1,4 +1,4 @@
-//! This crate provides ways of identifying an actor within the git repository both in shared/signature_ref and mutable variants.
+//! This crate provides ways of identifying an actor within the git repository both in shared/mutable and mutable variants.
 #![forbid(unsafe_code)]
 #![deny(rust_2018_idioms, missing_docs)]
 use bstr::{BStr, BString};

git-actor/src/signature/mod.rs

@@ -41,7 +41,7 @@ mod convert {
     }
 
     impl Signature {
-        /// Borrow this instance as signature_ref
+        /// Borrow this instance as immutable
         pub fn to_ref(&self) -> SignatureRef<'_> {
             SignatureRef {
                 name: self.name.as_ref(),

git-config/src/file/git_config.rs

@@ -306,7 +306,7 @@ impl<'event> GitConfig<'event> {
             .map_err(|_| GitConfigError::FailedConversion)
     }
 
-    /// Returns an signature_ref section reference.
+    /// Returns an immutable section reference.
     ///
     /// # Errors
     ///

git-object/src/immutable/mod.rs

@@ -1,8 +1,2 @@
-//! Immutable objects are read-only structures referencing most data from [a byte slice][crate::ObjectRef::from_bytes()].
-//!
-//! Immutable objects are expected to be deserialized from bytes that acts as backing store, and they
-//! cannot be mutated or serialized. Instead, one will [convert][crate::ObjectRef::into_owned()] them into their [`mutable`][crate::mutable] counterparts
-//! which support mutation and serialization.
-
 ///
 pub mod object;

git-object/src/immutable/object.rs

@@ -11,14 +11,14 @@ impl<'a> ObjectRef<'a> {
         })
     }
 
-    /// Convert the signature_ref object into a mutable version, consuming the source in the process.
+    /// Convert the immutable object into a mutable version, consuming the source in the process.
     ///
     /// Note that this is an expensive operation.
     pub fn into_owned(self) -> Object {
         self.into()
     }
 
-    /// Convert this signature_ref object into its mutable counterpart.
+    /// Convert this immutable object into its mutable counterpart.
     ///
     /// Note that this is an expensive operation.
     pub fn to_owned(&self) -> Object {

git-object/src/lib.rs

@@ -14,6 +14,7 @@ pub use types::{Error, Kind};
 
 use crate::tree::EntryRef;
 
+///
 pub mod immutable;
 
 ///
@@ -150,7 +151,13 @@ pub struct Tag {
     pub pgp_signature: Option<BString>,
 }
 
-/// An signature_ref object representing [`Trees`][TreeRef], [`Blobs`][BlobRef], [`Commits`][CommitRef], or [`Tags`][TagRef].
+/// Immutable objects are read-only structures referencing most data from [a byte slice][crate::ObjectRef::from_bytes()].
+///
+/// Immutable objects are expected to be deserialized from bytes that acts as backing store, and they
+/// cannot be mutated or serialized. Instead, one will [convert][crate::ObjectRef::into_owned()] them into their [`mutable`][crate::mutable] counterparts
+/// which support mutation and serialization.
+///
+/// An object is representing [`Trees`][TreeRef], [`Blobs`][BlobRef], [`Commits`][CommitRef], or [`Tags`][TagRef].
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
 #[cfg_attr(feature = "serde1", derive(serde::Serialize, serde::Deserialize))]
 #[allow(missing_docs)]

git-ref/src/lib.rs

@@ -71,7 +71,7 @@ pub enum Target {
     Symbolic(FullName),
 }
 
-/// Denotes a ref target, equivalent to [`Kind`], but with signature_ref data.
+/// Denotes a ref target, equivalent to [`Kind`], but with immutable data.
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
 pub enum TargetRef<'a> {
     /// A ref that points to an object id

git-repository/src/easy/mod.rs

@@ -113,7 +113,7 @@ pub struct State {
 
 /// A utility trait to represent access to a repository.
 ///
-/// It provides signature_ref and possibly mutable access. Both types of access are validated at runtime, which may fail
+/// It provides immutable and possibly mutable access. Both types of access are validated at runtime, which may fail
 /// or may block, depending on the implementation.
 ///
 /// Furthermore it provides access to additional state for use with the [`Repository`]. It is designed for thread-local