Skip to content

Commit 266c9fc

Browse files
committed
docs: clarify how Reference::peeled is working.
1 parent fb81093 commit 266c9fc

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

gix-ref/src/raw.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ pub struct Reference {
1010
pub name: FullName,
1111
/// The target of the reference, either a symbolic reference by full name or a possibly intermediate object by its id.
1212
pub target: Target,
13-
/// The fully peeled object to which this reference ultimately points to. Only guaranteed to be set after `peel_to_id_in_place()` was called.
13+
/// The fully peeled object to which this reference ultimately points to. Only guaranteed to be set after
14+
/// [`Reference::peel_to_id_in_place()`](crate::file::ReferenceExt) was called or if this reference originated
15+
/// from a packed ref.
1416
pub peeled: Option<ObjectId>,
1517
}
1618

0 commit comments

Comments
 (0)