Skip to content

Commit 49ef3df

Browse files
committed
Fix docstrings
1 parent 2f36fdb commit 49ef3df

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/cool_seq_tool/mappers/exon_genomic_coords.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ async def genomic_to_tx_segment(
461461
:param gene: A valid, case-sensitive HGNC symbol. Must be given if no ``transcript``
462462
value is provided.
463463
:param coordinate_type: Coordinate type for ``seg_start_genomic`` and
464-
``seg_end_genomic``
464+
``seg_end_genomic``. Expects inter-residue coordinates by default
465465
:return: Genomic data (inter-residue coordinates)
466466
"""
467467
errors = []
@@ -747,7 +747,6 @@ async def _genomic_to_tx_segment(
747747
errors.
748748
749749
:param genomic_pos: Genomic position where the transcript segment starts or ends
750-
(inter-residue based)
751750
:param chromosome: Chromosome. Must give chromosome without a prefix
752751
(i.e. ``1`` or ``X``). If not provided, must provide ``genomic_ac``. If
753752
position maps to both GRCh37 and GRCh38, GRCh38 assembly will be used.
@@ -769,7 +768,7 @@ async def _genomic_to_tx_segment(
769768
:param is_seg_start: ``True`` if ``genomic_pos`` is where the transcript segment starts.
770769
``False`` if ``genomic_pos`` is where the transcript segment ends.
771770
:param coordinate_type: Coordinate type for ``seg_start_genomic`` and
772-
``seg_end_genomic``
771+
``seg_end_genomic``. Expects inter-residue coordinates by default
773772
:return: Data for a transcript segment boundary (inter-residue coordinates)
774773
"""
775774
params = {key: None for key in GenomicTxSeg.model_fields}
@@ -1180,7 +1179,7 @@ def _use_alt_start_i(is_seg_start: bool, strand: Strand) -> bool:
11801179
:return ``True`` if alt_start_i should be used, ``False`` if alt_end_i should
11811180
be used
11821181
"""
1183-
return bool(
1182+
return (
11841183
is_seg_start
11851184
and strand == Strand.POSITIVE
11861185
or not is_seg_start
@@ -1249,7 +1248,8 @@ def _get_exon_offset(
12491248
"""Compute offset from exon start or end index
12501249
12511250
:param genomic_pos: The supplied genomic position. This can represent, for
1252-
example, a fusion junction breakpoint
1251+
example, a fusion junction breakpoint. This position is represented using
1252+
inter-residue coordinates
12531253
:param exon_boundary: The genomic position for the exon boundary that the offset
12541254
is being computed against
12551255
:paran strand: The transcribed strand

0 commit comments

Comments
 (0)