Menu

#3 XMI_ID comment lines break docstrings

open
nobody
None
5
2009-07-08
2009-07-08
No

Given a class or method docstring (""" .... """) PyUML reworks this docstring and adds a #-prefixed line for XMI_ID. However, docstrings are extracted by a variety of tools, including Python itself, for producing documentation on the class or method. As such, since the #-prefixed line is not a comment and thus gets extracted verbatim, thus polluting documentation.

The way forward would probably be to skip to the matching end """ and then put the XMI_ID line underneath it.

Discussion


Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.