From 6ab8245d673ffe5fa12a02a6ce0f9f03bee459d7 Mon Sep 17 00:00:00 2001 From: Yossi Farjoun Date: Thu, 19 Sep 2024 12:42:39 -0400 Subject: [PATCH] docs --- fgpyo/sam/__init__.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/fgpyo/sam/__init__.py b/fgpyo/sam/__init__.py index 76fe6fbf..26c0300f 100644 --- a/fgpyo/sam/__init__.py +++ b/fgpyo/sam/__init__.py @@ -548,8 +548,7 @@ def length_on_target(self) -> int: return sum([elem.length_on_target for elem in self.elements]) def get_query_alignment_offsets(self, reverse: bool = False) -> Optional[range]: - """ - Get the 0-based, end-exclusive positions of the first and last aligned base in the query. + """Gets the 0-based, end-exclusive positions of the first and last aligned base in the query. The resulting range will contain the range of positions in the SEQ string for the bases that are aligned. If no bases are aligned, the return value will be None. @@ -560,10 +559,10 @@ def get_query_alignment_offsets(self, reverse: bool = False) -> Optional[range]: Returns: A range, defining the start and stop offsets of the aligned part - of the query. These offsets are 0-based and open-ended, with respect to the - beginning of the query. (If 'reverse' is True, the offsets are with - respect to the reversed query.) - If no bases are aligned, the return value will be None. + of the query. These offsets are 0-based and open-ended, with respect to the + beginning of the query. (If 'reverse' is True, the offsets are with + respect to the reversed query.) + If no bases are aligned, the return value will be None. """ # breaking the build start_offset: int = 0