WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit bd408bb

Browse files
committed
docs: explicitly replicate the docstring
1 parent 0512e18 commit bd408bb

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

docs/implementations/python/api.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,22 @@ Python API
99

1010
.. manually documented as parse_annotation is undocumented
1111
12-
.. autofunction:: parse_annotation
12+
.. function:: parse_annotation
1313

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

16-
See :meth:`AnnotationStringParser.__call__` for more details about the implementation
17-
and actual arguments.
16+
Parameters
17+
----------
18+
annotation_string : str
19+
The string to be parsed
20+
wrap_errors : bool, optional
21+
Whether or not to capture parsing errors as :class:`InvalidAnnotation` or not. Defaults to :const:`False`.
22+
23+
Returns
24+
-------
25+
list[:class:`IonAnnotationBase`] :
26+
The annotations parsed
27+
28+
See Also
29+
--------
30+
:class:`mzpaf.AnnotationStringParser`

0 commit comments

Comments
 (0)