Skip to content

Commit

Permalink
docs: improve negative docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
clintval committed Aug 2, 2024
1 parent df6fab1 commit 34a63a6
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion pybedlite/bed_record.py
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,10 @@ def refname(self) -> str:

@property
def negative(self) -> bool:
"""True if the interval is on the negative strand, False otherwise"""
"""
True if the interval is negatively stranded, False if the interval is unstranded or
positively stranded.
"""
return self.strand is BedStrand.Negative

Check warning on line 196 in pybedlite/bed_record.py

View check run for this annotation

Codecov / codecov/patch

pybedlite/bed_record.py#L196

Added line #L196 was not covered by tests

def as_bed_line(self, number_of_output_fields: Optional[int] = None) -> str:
Expand Down

0 comments on commit 34a63a6

Please sign in to comment.