Skip to content

Commit

Permalink
#53 FIX docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jalew188 committed Jun 17, 2024
1 parent 640622d commit 6a9e13c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions alpharaw/mzml.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
class MzMLReader(MSData_Base):
"""
Load mzml file as `:class:`MSData_Base` structure.
This reader will be registered as "mzml"
This reader will be registered as "mzml"
in :obj:`alphraw.ms_data_base.ms_reader_provider`.
Expand All @@ -31,14 +31,14 @@ def _import(
mzml_file_path: str,
) -> dict:
"""
Implementation of :func:`alpharaw.ms_data_base.MSData_Base._import` interface,
Implementation of :func:`alpharaw.ms_data_base.MSData_Base._import` interface,
which will be called by :func:`alpharaw.ms_data_base.MSData_Base.import_raw`,
the main entry of :class:`alpharaw.ms_data_base.MSData_Base` sub-classes.
Parameters
----------
mzml_file_path : str
Absolute or relative path of the mzml file.
Absolute or relative path of the mzml file.
For testing purpose, this can be pyteomics `MzML` object as well.
Returns
Expand Down
2 changes: 1 addition & 1 deletion alpharaw/sciex.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
class SciexWiffData(MSData_Base):
"""
Load Sciex Wiff data as :class:`MSData_Base` data structure.
This reader will be registered as "sciex", "sciex_wiff", and "sciex_raw"
This reader will be registered as "sciex", "sciex_wiff", and "sciex_raw"
in :obj:`alpharaw.ms_data_base.ms_reader_provider`.
Parameters
Expand Down

0 comments on commit 6a9e13c

Please sign in to comment.