docformatter icon indicating copy to clipboard operation
docformatter copied to clipboard

Option to not format module description docstring

Open sammorley-short opened this issue 3 years ago • 1 comments
trafficstars

My organisation currently has a license header which doesn't conform to PEP 257, but I'd love to use docformatter for the rest of the module's contents.

I attempted to do this using the range option, but since the module description string also contains the module's description, one can know a minimum length for them, but not a maximum length.

It would be really great if docformatter had an option to toggle formatting of these module docstrings.

Thanks!

sammorley-short avatar Oct 26 '22 16:10 sammorley-short

+1 on this, it also screws up alembic revision file headers.

PS: Why are your license headers docstrings and not comments?

ThiefMaster avatar Jun 14 '23 09:06 ThiefMaster