Skip to content

Commit

Permalink
fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
jkanche committed Sep 20, 2023
1 parent 69bbaa4 commit fa1a1b2
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/genomicranges/GenomicRanges.py
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ def width(self) -> List[int]:

@property
def seq_info(self) -> Optional[SeqInfo]:
"""Get List information, if available.
"""Get sequence information, if available.
Returns:
(SeqInfo, optional): List information, otherwise None.
Expand All @@ -268,7 +268,7 @@ def seq_info(self) -> Optional[SeqInfo]:

@seq_info.setter
def seq_info(self, seq_info: Optional[SeqInfo]):
"""Set List information.
"""Set sequence information.
Args:
(SeqInfo, optional): List information, otherwise None.
Expand Down Expand Up @@ -342,7 +342,7 @@ def is_circular(self) -> Optional[Dict[str, bool]]:
Returns:
Dict[str, bool] or None: A dictionary with chromosome names as keys, and a
boolean value indicating whether they are circular or not, or None if not available.
boolean value indicating whether they are circular or not, or None if not available.
"""

if self.metadata is not None and "seqInfo" in self.metadata:
Expand Down Expand Up @@ -845,7 +845,7 @@ def restrict(
)

def trim(self) -> "GenomicRanges":
"""Trim Lists outside of bounds for non-circular chromosomes.
"""Trim sequences outside of bounds for non-circular chromosomes.
Returns:
GenomicRanges: A new `GenomicRanges` object with trimmed ranges.
Expand All @@ -868,7 +868,7 @@ def trim(self) -> "GenomicRanges":
raise ValueError("Cannot trim ranges. `seqlengths` is not available.")

if is_circular is None:
warn("considering all Lists as non-circular...")
warn("considering all sequences as non-circular...")

all_chrs = self.column("seqnames")
all_ends = self.column("ends")
Expand Down

0 comments on commit fa1a1b2

Please sign in to comment.