Skip to content

Commit 9155d8c

Browse files
committed
chore: clarify difference between contains_* methods
1 parent b6cb456 commit 9155d8c

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

omics-coordinate/src/interval.rs

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -556,9 +556,11 @@ where
556556
/// checks the coordinates themselves and, in-so-doing, considers both the
557557
/// start and the end positions of the interval to be inclusive.
558558
///
559-
/// If you'd like to check whether a particular nucleotide, amino acid, or
560-
/// other entity is contained within the interval, use the
561-
/// [`contains_entity()`](Interval::contains_entity) method.
559+
/// This method checks containment using coordinates in the interval's
560+
/// native coordinate system (the generic type `S`). If you'd like to
561+
/// check whether a particular nucleotide, amino acid, or other entity
562+
/// is contained within the interval (using in-base coordinates), use
563+
/// the [`contains_entity()`](Interval::contains_entity) method.
562564
///
563565
/// # Examples
564566
///
@@ -635,7 +637,13 @@ where
635637
/// Returns whether or not the entity at the in-base coordinate is
636638
/// contained within this interval.
637639
///
638-
/// /// # Examples
640+
/// This method always works with in-base coordinates (which directly point
641+
/// to entities like nucleotides or amino acids), regardless of the
642+
/// interval's coordinate system. Use
643+
/// [`contains_coordinate()`](Self::contains_coordinate) if you need to
644+
/// check containment using the interval's native coordinate system.
645+
///
646+
/// # Examples
639647
///
640648
/// ```
641649
/// use omics_coordinate::Coordinate;

0 commit comments

Comments
 (0)