Skip to content

Commit d82199c

Browse files
committed
Make it easier to discover is_path_excluded() in documentation
1 parent 7ec65fa commit d82199c

File tree

3 files changed

+3
-0
lines changed

3 files changed

+3
-0
lines changed

gix-worktree/src/stack/platform.rs

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ impl<'a> Platform<'a> {
2020
/// # Panics
2121
///
2222
/// If the cache was configured without exclude patterns.
23+
#[doc(alias = "is_path_ignored", alias = "git2")]
2324
pub fn is_excluded(&self) -> bool {
2425
self.matching_exclude_pattern()
2526
.map_or(false, |m| !m.pattern.is_negative())

gix/src/attribute_stack.rs

+1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ impl<'repo> AttributeStack<'repo> {
3939
/// path is created as directory. If it's not known it is assumed to be a file.
4040
///
4141
/// Provide access to cached information for that `relative` path via the returned platform.
42+
#[doc(alias = "is_path_ignored", alias = "git2")]
4243
pub fn at_path(
4344
&mut self,
4445
relative: impl AsRef<std::path::Path>,

gix/src/repository/attributes.rs

+1
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ impl Repository {
106106
/// When only excludes are desired, this is the most efficient way to obtain them. Otherwise use
107107
/// [`Repository::attributes()`] for accessing both attributes and excludes.
108108
// TODO: test
109+
#[doc(alias = "is_path_ignored", alias = "git2")]
109110
#[cfg(feature = "excludes")]
110111
pub fn excludes(
111112
&self,

0 commit comments

Comments
 (0)