search

PyCQA / docformatter

Formats docstrings to follow PEP 257
https://pypi.python.org/pypi/docformatter
MIT License
530 stars 61 forks source link

descriptions in alembic revision files gets broken #242

Closed finswimmer closed 1 year ago

finswimmer commented 1 year ago

Hey,

alembic adds something like this to each revision file:

"""Add some column.

Revision ID: <some id>>
Revises: <some other id>
Create Date: 2023-01-06 10: 13:28.156709
"""

Starting from docformatter 1.7.1 on, docformatter breaks this description:

"""Add some column.

Revision ID: <some id>> Revises: <some other id> Create Date
: 2023-01-06 10: 13:28.156709
"""

I guess this has something to do with https://github.com/PyCQA/docformatter/pull/201

Any chance to get this fixed?

fin swimmer

BTW: Thanks a lot for this wonderful tool!

weibullguy commented 1 year ago

@finswimmer this is fixed in v1.7.3-rc3 if you'd like to give it a try. Or you can wait until v1.7.3 is released.

finswimmer commented 1 year ago

Thanks for your quick answer @weibullguy :pray:

I tried 1.7.3-rc3. Unfortunately the behavior hasn't change there.

weibullguy commented 1 year ago

Sorry @finswimmer, I didn't catch that this is a module docstring (at the top of the file); I assumed it was docstring in a function/method. It should be fixed in v1.7.3-rc4.

finswimmer commented 1 year ago

v1.7.3-rc4 fixed this :partying_face: Thanks a lot :pray: