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

Close

#235 newfield tag

v3.0
closed-fixed
Edward Loper
epytext (18)
5
2008-01-29
2007-11-27
Anonymous
No

I'd like to define a custom field for an entire package or module, but the newfield tag doesn't seem to work outside of class definition.

According to the docs, I should at least be able to do this at the module level. However, when I put:

'''
@newfield example: Example
'''

at the top of my module and run epydoc, I get:

Warning: Unknown field tag u'example'

and the example tag that I used in one of my functions doesnt show up.

If I place the @newfield inside my class docstring it works as expected, except that the plural form still doesnt seem to work there. When I do this:

class Knight( object ):
'''
@newfield example: Example, Examples

invincible, black...
'''

I get:
Warning: Bad newfield: Bad arg 2 (expected "short")
and then
Warning: Unknown field tag u'example'

Python 2.5.1 (r251:54863, Jul 26 2007, 12:02:45)
[GCC 3.4.6 20060404 (Red Hat 3.4.6-3)] on linux2

cheers

Discussion

  • Edward Loper
    Edward Loper
    2008-01-29

    • status: open --> closed-fixed
     
  • Edward Loper
    Edward Loper
    2008-01-29

    Logged In: YES
    user_id=195958
    Originator: NO

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