Skip to content

Commit

Permalink
doc: doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
msto committed Feb 12, 2025
1 parent 8077aec commit 7577de4
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
3 changes: 1 addition & 2 deletions fgpyo/sam/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,7 @@ def _pysam_open(
file_type: the file type to assume when opening the file. If None, then the file type
will be auto-detected for reading and must be a path-like object for writing.
unmapped: True if the file is unmapped and has no sequence dictionary, False otherwise.
kwargs: any keyword arguments to be passed to
`pysam.AlignmentFile`; may not include "mode".
kwargs: any keyword arguments to be passed to `pysam.AlignmentFile`; may not include "mode".
"""

if isinstance(path, (str, Path)):
Expand Down
4 changes: 2 additions & 2 deletions fgpyo/util/inspect.py
Original file line number Diff line number Diff line change
Expand Up @@ -317,10 +317,10 @@ def _get_parser( # noqa: C901
Args:
cls: the type of the class object this is being parsed for (used to get default val for
parsers)
parsers)
type_: the type of the attribute to be parsed
parsers: an optional mapping from type to the function to use for parsing that type (allows
for parsing of more complex types)
for parsing of more complex types)
"""
parser: partial[type_]
if parsers is None:
Expand Down
4 changes: 2 additions & 2 deletions fgpyo/util/metric.py
Original file line number Diff line number Diff line change
Expand Up @@ -394,8 +394,8 @@ def _read_header(
Args:
reader: An open, readable file handle.
file_format: A dataclass containing (at minimum) the file's delimiter and the string
prefixing any comment lines.
delimiter: The delimiter character used to separate fields in the file.
comment_prefix: The prefix for comment lines in the file.
Returns:
A `MetricFileHeader` containing the field names and any preceding lines.
Expand Down

0 comments on commit 7577de4

Please sign in to comment.