Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

#231 Exception with __authors__ tuple

devel (cvs)
closed-fixed
Edward Loper
5
2008-01-29
2007-11-04
Martin Geisler
No

When trying to document this file:

"""Test."""

__authors__ = ('foo', 'bar', 'baz')

I get the following traceback:

Traceback (most recent call last):
File "/home/mg/opt/bin/epydoc", line 13, in ?
cli()
File "/home/mg/opt/lib/python/epydoc/cli.py", line 957, in cli
main(options, names)
File "/home/mg/opt/lib/python/epydoc/cli.py", line 749, in main
exclude_parse=exclude_parse)
File "/home/mg/opt/lib/python/epydoc/docbuilder.py", line 261, in build_doc_index
parse_docstring(val_doc, docindex)
File "/home/mg/opt/lib/python/epydoc/docstringparser.py", line 258, in parse_docstring
add_metadata_from_var(api_doc, field)
File "/home/mg/opt/lib/python/epydoc/docstringparser.py", line 330, in add_metadata_from_var
del api_doc.variables[varname]
KeyError: '__authors__'

I thought that specifying a tuple/list was the correct way to specify multiple authors. I used the latest SVN version.

Discussion

  • Logged In: NO

    I receive this error as well. It looks like string types are the
    only supported types for values of these key words. It would be
    nice if Epydoc supported list types that it would format as strings, or
    at least gracefully handled this error case instead of dying.

     
  • Edward Loper
    Edward Loper
    2008-01-29

    Logged In: YES
    user_id=195958
    Originator: NO

    Thanks for pointing this out. Fixed in svn revision 1668.

     
  • Edward Loper
    Edward Loper
    2008-01-29

    • assigned_to: nobody --> edloper
    • status: open --> closed-fixed