Skip to content

Commit 995bc84

Browse files
committed
fix docs
1 parent 345712d commit 995bc84

File tree

11 files changed

+23
-23
lines changed

11 files changed

+23
-23
lines changed

gix-commitgraph/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ use std::path::Path;
2020
/// A single commit-graph file.
2121
///
2222
/// All operations on a `File` are local to that graph file. Since a commit graph can span multiple
23-
/// files, all interesting graph operations belong on [`Graph`][crate::Graph].
23+
/// files, all interesting graph operations belong on [`Graph`].
2424
pub struct File {
2525
base_graph_count: u8,
2626
base_graphs_list_offset: Option<usize>,

gix-diff/src/tree/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ pub mod visit;
4141
#[doc(inline)]
4242
pub use visit::Visit;
4343

44-
/// A [Visit][visit::Visit] implementation to record every observed change and keep track of the changed paths.
44+
/// A [Visit] implementation to record every observed change and keep track of the changed paths.
4545
#[derive(Clone, Debug)]
4646
pub struct Recorder {
4747
path_deque: VecDeque<BString>,

gix-filter/src/pipeline/convert.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ pub enum ToWorktreeOutcome<'input, 'pipeline> {
258258
}
259259

260260
impl<'input, 'pipeline> ToWorktreeOutcome<'input, 'pipeline> {
261-
/// Return true if this outcome is delayed. In that case, one isn't allowed to use [`Read`][std::io::Read] or cause a panic.
261+
/// Return true if this outcome is delayed. In that case, one isn't allowed to use [`Read`] or cause a panic.
262262
pub fn is_delayed(&self) -> bool {
263263
matches!(
264264
self,

gix-index/src/init.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ mod from_tree {
3131
fs_monitor: None,
3232
}
3333
}
34-
/// Create an index [`State`][crate::State] by traversing `tree` recursively, accessing sub-trees
34+
/// Create an index [`State`] by traversing `tree` recursively, accessing sub-trees
3535
/// with `find`.
3636
///
3737
/// **No extension data is currently produced**.

gix-object/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ pub struct CommitRef<'a> {
9898
pub extra_headers: Vec<(&'a BStr, Cow<'a, BStr>)>,
9999
}
100100

101-
/// Like [`CommitRef`][crate::CommitRef], but as `Iterator` to support (up to) entirely allocation free parsing.
101+
/// Like [`CommitRef`], but as `Iterator` to support (up to) entirely allocation free parsing.
102102
/// It's particularly useful to traverse the commit graph without ever allocating arrays for parents.
103103
#[derive(Copy, Clone)]
104104
pub struct CommitRefIter<'a> {

gix-object/src/object/mod.rs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -66,66 +66,66 @@ mod write {
6666

6767
/// Convenient extraction of typed object.
6868
impl Object {
69-
/// Turns this instance into a [`Blob`][Blob], panic otherwise.
69+
/// Turns this instance into a [`Blob`], panic otherwise.
7070
pub fn into_blob(self) -> Blob {
7171
match self {
7272
Object::Blob(v) => v,
7373
_ => panic!("BUG: not a blob"),
7474
}
7575
}
76-
/// Turns this instance into a [`Commit`][Commit] panic otherwise.
76+
/// Turns this instance into a [`Commit`] panic otherwise.
7777
pub fn into_commit(self) -> Commit {
7878
match self {
7979
Object::Commit(v) => v,
8080
_ => panic!("BUG: not a commit"),
8181
}
8282
}
83-
/// Turns this instance into a [`Tree`][Tree] panic otherwise.
83+
/// Turns this instance into a [`Tree`] panic otherwise.
8484
pub fn into_tree(self) -> Tree {
8585
match self {
8686
Object::Tree(v) => v,
8787
_ => panic!("BUG: not a tree"),
8888
}
8989
}
90-
/// Turns this instance into a [`Tag`][Tag] panic otherwise.
90+
/// Turns this instance into a [`Tag`] panic otherwise.
9191
pub fn into_tag(self) -> Tag {
9292
match self {
9393
Object::Tag(v) => v,
9494
_ => panic!("BUG: not a tag"),
9595
}
9696
}
97-
/// Turns this instance into a [`Blob`][Blob] if it is one.
97+
/// Turns this instance into a [`Blob`] if it is one.
9898
#[allow(clippy::result_large_err)]
9999
pub fn try_into_blob(self) -> Result<Blob, Self> {
100100
match self {
101101
Object::Blob(v) => Ok(v),
102102
_ => Err(self),
103103
}
104104
}
105-
/// Turns this instance into a [`BlobRef`][BlobRef] if it is a blob.
105+
/// Turns this instance into a [`BlobRef`] if it is a blob.
106106
pub fn try_into_blob_ref(&self) -> Option<BlobRef<'_>> {
107107
match self {
108108
Object::Blob(v) => Some(v.to_ref()),
109109
_ => None,
110110
}
111111
}
112-
/// Turns this instance into a [`Commit`][Commit] if it is one.
112+
/// Turns this instance into a [`Commit`] if it is one.
113113
#[allow(clippy::result_large_err)]
114114
pub fn try_into_commit(self) -> Result<Commit, Self> {
115115
match self {
116116
Object::Commit(v) => Ok(v),
117117
_ => Err(self),
118118
}
119119
}
120-
/// Turns this instance into a [`Tree`][Tree] if it is one.
120+
/// Turns this instance into a [`Tree`] if it is one.
121121
#[allow(clippy::result_large_err)]
122122
pub fn try_into_tree(self) -> Result<Tree, Self> {
123123
match self {
124124
Object::Tree(v) => Ok(v),
125125
_ => Err(self),
126126
}
127127
}
128-
/// Turns this instance into a [`Tag`][Tag] if it is one.
128+
/// Turns this instance into a [`Tag`] if it is one.
129129
#[allow(clippy::result_large_err)]
130130
pub fn try_into_tag(self) -> Result<Tag, Self> {
131131
match self {
@@ -134,28 +134,28 @@ impl Object {
134134
}
135135
}
136136

137-
/// Returns a [`Blob`][Blob] if it is one.
137+
/// Returns a [`Blob`] if it is one.
138138
pub fn as_blob(&self) -> Option<&Blob> {
139139
match self {
140140
Object::Blob(v) => Some(v),
141141
_ => None,
142142
}
143143
}
144-
/// Returns a [`Commit`][Commit] if it is one.
144+
/// Returns a [`Commit`] if it is one.
145145
pub fn as_commit(&self) -> Option<&Commit> {
146146
match self {
147147
Object::Commit(v) => Some(v),
148148
_ => None,
149149
}
150150
}
151-
/// Returns a [`Tree`][Tree] if it is one.
151+
/// Returns a [`Tree`] if it is one.
152152
pub fn as_tree(&self) -> Option<&Tree> {
153153
match self {
154154
Object::Tree(v) => Some(v),
155155
_ => None,
156156
}
157157
}
158-
/// Returns a [`Tag`][Tag] if it is one.
158+
/// Returns a [`Tag`] if it is one.
159159
pub fn as_tag(&self) -> Option<&Tag> {
160160
match self {
161161
Object::Tag(v) => Some(v),

gix-odb/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ pub struct Cache<S> {
5050
pub mod cache;
5151

5252
///
53-
/// It can optionally compress the content, similarly to what would happen when using a [`loose::Store`][crate::loose::Store].
53+
/// It can optionally compress the content, similarly to what would happen when using a [`loose::Store`].
5454
///
5555
#[derive(Clone)]
5656
pub struct Sink {

gix-pathspec/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ pub enum SearchMode {
134134
PathAwareGlob,
135135
}
136136

137-
/// Parse a git-style pathspec into a [`Pattern`][Pattern],
137+
/// Parse a git-style pathspec into a [`Pattern`],
138138
/// setting the given `default` values in case these aren't specified in `input`.
139139
///
140140
/// Note that empty [paths](Pattern::path) are allowed here, and generally some processing has to be performed.

gix-ref/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//! Refs are the way to keep track of objects and come in two flavors.
66
//!
77
//! * symbolic refs are pointing to another reference
8-
//! * peeled refs point to the an object by its [`ObjectId`][gix_hash::ObjectId]
8+
//! * peeled refs point to the an object by its [`ObjectId`]
99
//!
1010
//! They can be identified by a relative path and stored in various flavors.
1111
//!

gix-ref/src/name.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use gix_object::bstr::{BStr, BString, ByteSlice, ByteVec};
44

55
use crate::{Category, FullName, FullNameRef, PartialName, PartialNameRef};
66

7-
/// The error used in the [`PartialNameRef`][super::PartialNameRef]`::try_from`(…) implementations.
7+
/// The error used in the [`PartialNameRef`]`::try_from`(…) implementations.
88
pub type Error = gix_validate::reference::name::Error;
99

1010
impl<'a> Category<'a> {

gix-traverse/src/tree/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ pub trait Visit {
2727
fn visit_nontree(&mut self, entry: &gix_object::tree::EntryRef<'_>) -> visit::Action;
2828
}
2929

30-
/// A [Visit][Visit] implementation to record every observed change and keep track of the changed paths.
30+
/// A [Visit] implementation to record every observed change and keep track of the changed paths.
3131
///
3232
/// Recorders can also be instructed to track the filename only, or no location at all.
3333
#[derive(Clone, Debug)]

0 commit comments

Comments
 (0)