Skip to content

Commit

Permalink
docs: improve documentation throughout
Browse files Browse the repository at this point in the history
  • Loading branch information
clintval committed Aug 1, 2024
1 parent 2d9625c commit 74f7d03
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions pybedlite/overlap_detector.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
for sorting them in :func:`~pybedlite.overlap_detector.OverlapDetector.get_overlaps` using
the following property if it is present, otherwise assumed to be positive stranded:
* `negative (bool)`: True if the span is negatively stranded, False if the interval is
* `negative (bool)`: True if the interval is negatively stranded, False if the interval is
unstranded or positively stranded
This is encapsulated in the :class:`~pybedlite.overlap_detector.StrandedGenomicSpan` protocol.
Expand Down Expand Up @@ -108,7 +108,7 @@ class StrandedGenomicSpan(GenomicSpan, Protocol):
@property
def negative(self) -> bool:
"""
True if the span is negatively stranded, False if the interval is unstranded or
True if the interval is negatively stranded, False if the interval is unstranded or
positively stranded.
"""

Expand All @@ -121,7 +121,7 @@ class Interval:
refname (str): the refname (or chromosome)
start (int): the 0-based start position
end (int): the 0-based end position (exclusive)
negative (bool): true if the span is negatively stranded, False if the interval is
negative (bool): true if the interval is negatively stranded, False if the interval is
unstranded or positively stranded
name (Optional[str]): an optional name assigned to the interval
"""
Expand Down Expand Up @@ -380,8 +380,8 @@ def get_overlaps(self, interval: GenomicSpan) -> List[GenericGenomicSpan]:
@staticmethod
def _negative(interval: GenomicSpan) -> bool:
"""
True if the span is negatively stranded, False if the interval is unstranded or positively
stranded.
True if the interval is negatively stranded, False if the interval is unstranded or
positively stranded.
"""
return getattr(interval, "negative", False)

Expand Down

0 comments on commit 74f7d03

Please sign in to comment.