pyment
pyment copied to clipboard
javadoc: @returns get parsed incorrectly
Example:
def method(self):
"""Short description
@returns: some return val
"""
pass
Gets converted to:
def method(self):
"""Short description
Returns:
s: some return val
"""
pass
Hi @thughes Indeed it seems that when "return' is written with an ending "s" it pyment will consider it as a kind of parameter. This should be addressed.
The current pip version (0.3.3?) exhibits the behavior reported above, while the current git version adds another, indented @returns: line as well!
@param name: param desc
@returns: return desc
"""
Turns into this:
:param name: param desc
@returns: return desc
:returns: s: return desc
"""
That extra line's indentation is also wrong: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists, but that's