Issue 109 in mingus: docstrings should be PEP 257 compliant

[min...@googlecode.com]

Status: Accepted
Owner: carlo.stemberger
Labels: Type-Defect Priority-Medium

New issue 109 by carlo.stemberger: docstrings should be PEP 257 compliant
http://code.google.com/p/mingus/issues/detail?id=109

http://www.python.org/dev/peps/pep-0257/

Basically we have to chose between

def foo():
"""Return bar and baz."""

and

def foo():
"""
Return bar and baz.
Raise FooError randomly blah blah,
blah blah.
"""

(with correct indentation, max. 80 chars for line and no "\").

I also think examples should be removed from docstrings, and auto-generated
by invoking mingus itself. This[1] could be useful.

Otherwise help() can't work properly.

Regards,
Carlo

[1] http://docs.python.org/library/inspect.html#inspect.cleandoc

[min...@googlecode.com]

Comment #1 on issue 109 by carlo.stemberger: docstrings should be PEP 257
compliant
http://code.google.com/p/mingus/issues/detail?id=109

to chose → to choose

sorry...

[min...@googlecode.com]

Comment #2 on issue 109 by Rhijnauwen: docstrings should be PEP 257
compliant
http://code.google.com/p/mingus/issues/detail?id=109

The reason the docstrings look so strange is that they are used to generate
the reference documentation. I'm all for putting it in a more sane,
standard format, but we should keep in mind that the reference doc
generator should be updated accordingly.

[min...@googlecode.com]

Updates:
Status: Started

Comment #3 on issue 109 by carlo.stemberger: docstrings should be PEP 257
compliant
http://code.google.com/p/mingus/issues/detail?id=109

I'm working on generate_wiki_docs.py.

[min...@googlecode.com]

Updates:
Status: Fixed

Comment #4 on issue 109 by carlo.stemberger: docstrings should be PEP 257
compliant
http://code.google.com/p/mingus/issues/detail?id=109

This issue was closed by revision 5fb5ba43bac4.