pycco-docs / pycco

Literate-style documentation generator.
https://pycco-docs.github.io/pycco/
Other
845 stars 143 forks source link

Docstrings #32

Closed lukearno closed 13 years ago

lukearno commented 13 years ago

pycco is rad but seems to fall down on docstrings.

If I have a function with a docstring like this:

def foo():
    """This is a docstring."""

The closing triplequotes seem to be missed by the parser. When I try putting them on a new line:

def foo():
    """This is a docstring.

    Ok, I'll just use a multiline docstring...
    """

There is ugly whitespace and the docstring is treated like a comment on the code inside the function and not on the function itself. .

amcgregor commented 13 years ago

I, too, suffer this problem. Single-line docstrings absorb the following code into the generated comment.

treyhunner commented 13 years ago

Fixed by pull request #38, which is now merged.