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.

Sign up for GitHub

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

Jump to bottom

Option to not format module description docstring #126

Open
sammorley-short opened this issue Oct 26, 2022 · 1 comment
Open

Option to not format module description docstring #126

sammorley-short opened this issue Oct 26, 2022 · 1 comment
Labels
C: stakeholder Relates to docformatter stakeholder requested behavior P: enhancement Feature that is outside the scope of PEP 257 U: low A relatively low urgency issue
Milestone
v2.0.0

Comments

@sammorley-short
Copy link

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!
@github-actions github-actions bot added the fresh This is a new issue label Oct 26, 2022
@weibullguy weibullguy added P: enhancement Feature that is outside the scope of PEP 257 V: minor Bumps the minor version C: stakeholder Relates to docformatter stakeholder requested behavior and removed fresh This is a new issue V: minor Bumps the minor version labels Nov 7, 2022
@weibullguy weibullguy added the V: minor Bumps the minor version label Dec 16, 2022
@weibullguy weibullguy removed the V: minor Bumps the minor version label Jan 19, 2023
@weibullguy weibullguy added this to the v2.0.0 milestone Jan 23, 2023
@weibullguy weibullguy added P: enhancement Feature that is outside the scope of PEP 257 and removed P: enhancement Feature that is outside the scope of PEP 257 labels Jun 7, 2023
@github-actions github-actions bot added the U: low A relatively low urgency issue label Jun 7, 2023
@ThiefMaster
Copy link

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

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

@weibullguy weibullguy mentioned this issue Jun 20, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C: stakeholder Relates to docformatter stakeholder requested behavior P: enhancement Feature that is outside the scope of PEP 257 U: low A relatively low urgency issue
Projects
None yet
Milestone
v2.0.0
Development

No branches or pull requests
3 participants
@ThiefMaster @weibullguy @sammorley-short