From fa1a1b2419971aa431811acbc8bc03b08419e4e8 Mon Sep 17 00:00:00 2001 From: Jayaram Kancherla Date: Tue, 19 Sep 2023 21:55:42 -0700 Subject: [PATCH] fix docstring --- src/genomicranges/GenomicRanges.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/genomicranges/GenomicRanges.py b/src/genomicranges/GenomicRanges.py index 13fcbfa..70c4d4a 100644 --- a/src/genomicranges/GenomicRanges.py +++ b/src/genomicranges/GenomicRanges.py @@ -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. @@ -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. @@ -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: @@ -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. @@ -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")