Skip to content

Failed See Also Parsing. #281

Closed
Closed
@Carreau

Description

@Carreau
In [1]: from numpydoc.docscrape import NumpyDocString
   ...: from numpy import seterrobj
   ...: NumpyDocString("""seterrobj(errobj)
   ...:
   ...:     Set the object that defines floating-point error handling.
   ...:
   ...:     See Also
   ...:     --------
   ...:     geterrobj, seterr, geterr, seterrcall, geterrcall
   ...:     getbufsize, setbufsize""")['See Also']
Out[1]: []

In [2]:
diff --git a/numpydoc/docscrape.py b/numpydoc/docscrape.py
index 77de401..d79992c 100644
--- a/numpydoc/docscrape.py
+++ b/numpydoc/docscrape.py
@@ -284,6 +284,8 @@ class NumpyDocString(Mapping):

         """

+        content = dedent_lines(content)
         items = []

         def parse_item_name(text):

Might be enough, but it may also be the wrong place to put that:

In [1]: from numpydoc.docscrape import NumpyDocString
   ...: from numpy import seterrobj
   ...: NumpyDocString("""seterrobj(errobj)
   ...:
   ...:     Set the object that defines floating-point error handling.
   ...:
   ...:     See Also
   ...:     --------
   ...:     geterrobj, seterr, geterr, seterrcall, geterrcall
   ...:     getbufsize, setbufsize""")['See Also']
Out[1]:
[([('geterrobj', None),
   ('seterr', None),
   ('geterr', None),
   ('seterrcall', None),
   ('geterrcall', None)],
  []),
 ([('getbufsize', None), ('setbufsize', None)], [])]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions