Skip to content

Commit fad0118

Browse files
committed
Reference new methods in docs for ChangeRef::field()
1 parent a0cef8b commit fad0118

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

gix-diff/src/index/change.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,12 @@ impl ChangeRef<'_, '_> {
8282
/// Return all shared fields among all variants: `(location, index, entry_mode, id)`
8383
///
8484
/// In case of rewrites, the fields return to the current change.
85+
///
86+
/// Note that there are also more specific accessors in case you only need to access to one of
87+
/// these fields individually.
88+
///
89+
/// See [`ChangeRef::location()`], [`ChangeRef::index()`], [`ChangeRef::entry_mode()`] and
90+
/// [`ChangeRef::id()`].
8591
pub fn fields(&self) -> (&BStr, usize, gix_index::entry::Mode, &gix_hash::oid) {
8692
match self {
8793
ChangeRef::Addition {

0 commit comments

Comments
 (0)