Skip to content

Commit

Permalink
docs: explicitly replicate the docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
mobiusklein committed Nov 30, 2024
1 parent 0512e18 commit bd408bb
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions docs/implementations/python/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,22 @@ Python API

.. manually documented as parse_annotation is undocumented
.. autofunction:: parse_annotation
.. function:: parse_annotation

Parse a string into one or more :class:`IonAnnotationBase` instances.

See :meth:`AnnotationStringParser.__call__` for more details about the implementation
and actual arguments.
Parameters
----------
annotation_string : str
The string to be parsed
wrap_errors : bool, optional
Whether or not to capture parsing errors as :class:`InvalidAnnotation` or not. Defaults to :const:`False`.

Returns
-------
list[:class:`IonAnnotationBase`] :
The annotations parsed

See Also
--------
:class:`mzpaf.AnnotationStringParser`

0 comments on commit bd408bb

Please sign in to comment.