Skip to content

Commit ddb978e

Browse files
committed
Basic docs for IndividualId
1 parent ff8ea63 commit ddb978e

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/lib.rs

+5
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,11 @@ pub use bindings::tsk_size_t;
142142
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, std::hash::Hash)]
143143
pub struct NodeId(tsk_id_t);
144144

145+
/// An individual ID
146+
///
147+
/// This is an integer referring to a row of an [``IndividualTable``].
148+
///
149+
/// The features for this type follow the same pattern as for [``NodeId``]
145150
#[repr(transparent)]
146151
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, std::hash::Hash)]
147152
pub struct IndividualId(tsk_id_t);

0 commit comments

Comments
 (0)