Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

descriptions in alembic revision files gets broken #242

Closed
finswimmer opened this issue Jun 20, 2023 · 4 comments · Fixed by #238
Closed

descriptions in alembic revision files gets broken #242

finswimmer opened this issue Jun 20, 2023 · 4 comments · Fixed by #238
Labels
C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) P: bug PEP 257 violation or existing functionality that doesn't work as documented U: medium A relatively medium urgency issue
Milestone

Comments

@finswimmer
Copy link

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 #201

Any chance to get this fixed?

fin swimmer

BTW: Thanks a lot for this wonderful tool!

@github-actions github-actions bot added the fresh This is a new issue label Jun 20, 2023
@weibullguy weibullguy added P: bug PEP 257 violation or existing functionality that doesn't work as documented C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) and removed fresh This is a new issue labels Jun 20, 2023
@github-actions github-actions bot added the U: medium A relatively medium urgency issue label Jun 20, 2023
@weibullguy
Copy link
Member

@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.

@weibullguy weibullguy added this to the v1.8.0 milestone Jun 20, 2023
@finswimmer
Copy link
Author

Thanks for your quick answer @weibullguy 🙏

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

@weibullguy
Copy link
Member

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
Copy link
Author

v1.7.3-rc4 fixed this 🥳 Thanks a lot 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) P: bug PEP 257 violation or existing functionality that doesn't work as documented U: medium A relatively medium urgency issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants