jonnyjd / epydoc-m Goto Github PK

Error: Internal error during parsing
       'str' object has no attribute 'docstring'

part of the trace on master:

File "/usr/lib/python2.7/site-packages/epydoc/docparser.py", line 638, in process_file
  lineno, comments, decorators, encoding)
File "/usr/lib/python2.7/site-packages/epydoc/docparser.py", line 771, in process_line
  return process_docstring(*args)
File "/usr/lib/python2.7/site-packages/epydoc/docparser.py", line 1383, in process_docstring
  if prev_line_doc.docstring not in (None, UNKNOWN):
AttributeError: 'str' object has no attribute 'docstring'

test snippet where this stacktrace occurs:

if __name__ == '__main__': pass
"""docstring2"""

The string object is "skip_block" for prev_line_doc.

This was reported in http://sourceforge.net/support/tracker.php?aid=3489092

There is a patch at sourceforge implementing @diagnostics fields.

https://sourceforge.net/support/tracker.php?aid=1887564

This patch adds a new field, called @diagnostics, which is treated like other indexed fields, such as @todo, and @bug.

The idea behind the patch is to allow developers to create diagnostics sections in their documentation, that contains a list >of error messages that the code generates, along with a snippet of text about what it means. For example:

@diagnostics: C{Unrecognized token in config file: %s}

The config file contained an invalid token. This may be caused by a typo, if you edited the file by hand, or the >pluralization of a keyword where the singular was expected. If you haven't changed the file by hand, the config file may >have been created with an earlier version of the software, which had a slightly different format. See the "Config Files" >section if the upgrade documentation.

The attached patch fixes the epydoc docstring parser, docwriter, and the documentation. It makes no changes to >documentation generated in Latex, or with the javaDoc or reStructuredText formats.

Testing has been adhoc, and no additional test cases were added to the doctests.

init.py still includes Python 2.3+ as a requirement. We either need to change or check that. We can possibly backport some fixes in stable, but Python 2.4 came out in 2004 and we might just change it to 2.4+.
TODO: test if v3.0.1 actually runs with python 2.4.

We also need to change the project name and append to the list of contributors.

setup.py
is also a place to change.

Additionally the README.txt might need some changes.

 -o PATH, --output=PATH
                       The output directory.  If PATH does not exist, then it
                       will be created.

Is in the usage information.

epydoc -o doc/latest src

doesnt't work when doc doesn't exist.

The usual scenario, doc exists, works fine. latest is created then.