Collaboration about docformatter HOT 8 CLOSED

Hi, finding your project (in a stackoverflow post) is what triggered me to start docformatter a few days ago. I ran pep257.py on one of my larger projects (non-github) and found plenty of formatting problems. I was using this style, which for some reason I thought was standard practice.

"""
My function.

More stuff.
"""

I put together this script just to quickly fix the easy issues. (The rest like missing return type documentation, I fixed by hand of course.) Currently I'm mainly only formatting the summary of the docstring and the quotes themselves. If you have any ideas, I'm welcome to collaboration. I'll add you as a collaborator on this repository.

from docformatter.

By the way, I added a TODO file with some of the features that docformatter is currently missing.

from docformatter.

Regarding the style, the requirement is The summary line may be on the same line as the opening quotes or on the next line.
So your example above is not wrong.

You have additional examples which look the same in PEP 287.
http://www.python.org/dev/peps/pep-0287/

from docformatter.

Ah, thanks for pointing that out. I should make that optional in docformatter as well.

from docformatter.

I've added a --pre-summary-newline option.

from docformatter.

I also added the convenience option --alternate-style which produces the above style.

from docformatter.

(sorry for not showing up with colloboration yet—busy with my "docopt" project). Comment about --alternate style:
pep257 is saying a lot of may and recommended and the whole thing is not mandatory, but in the pep257 I decided that all the recommendations should be followed by default, and it's not tools job to decide which of them to skip.

In the spirit of TSBOAPOOOWTDI I propose to support only one style (canonical, with all pep257 recommendation)—because that style is just beautiful.

from docformatter.

Right, it is not the tool's job to determine which to skip. Considering that, adding --alternate-style may be going too far. But I think the other options are necessary. Of course, the default (with no options) would enforce all recommendations.

from docformatter.