diff --git a/docs/implementations/python/api.rst b/docs/implementations/python/api.rst index e5ba96d..30f14dd 100644 --- a/docs/implementations/python/api.rst +++ b/docs/implementations/python/api.rst @@ -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. \ No newline at end of file + 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` \ No newline at end of file