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

Allow in-place option in configuration files #122

Closed
janosh opened this issue Oct 18, 2022 · 1 comment
Closed

Allow in-place option in configuration files #122

janosh opened this issue Oct 18, 2022 · 1 comment
Labels
C: stakeholder Relates to docformatter stakeholder requested behavior P: enhancement Feature that is outside the scope of PEP 257 S: merged Closed with work merged to repository
Milestone

Comments

@janosh
Copy link

janosh commented Oct 18, 2022

Setting

# setup.cfg
[docformatter]
in-place = true

has no effect.

docformatter --config setup.cfg path/fo/file.py

still prints to terminal, leaving path/fo/file.py unchanged.

@github-actions github-actions bot added the fresh This is a new issue label Oct 18, 2022
@weibullguy weibullguy added P: bug PEP 257 violation or existing functionality that doesn't work as documented V: patch Bumps the patch version C: stakeholder Relates to docformatter stakeholder requested behavior and removed fresh This is a new issue labels Oct 18, 2022
@weibullguy weibullguy added P: enhancement Feature that is outside the scope of PEP 257 and removed P: bug PEP 257 violation or existing functionality that doesn't work as documented labels Dec 16, 2022
@weibullguy
Copy link
Member

@janosh there are some options that can't be configured in the config files. These are --in-place, --check, --diff, and --exclude. These must be passed with the command. This isn't documented as it should be, so it's understandable you reported this as a bug. I am updating the title of this issue to reflect your report as a request for a new feature to be included in v1.6.0.

@weibullguy weibullguy changed the title in-place in setup.cfg not working Allow in-place option in configuration files Dec 16, 2022
@github-actions github-actions bot added the fresh This is a new issue label Dec 16, 2022
@weibullguy weibullguy added V: minor Bumps the minor version and removed V: patch Bumps the patch version fresh This is a new issue labels Dec 16, 2022
@weibullguy weibullguy added this to the v1.6.0 milestone Dec 16, 2022
@weibullguy weibullguy added the S: merged Closed with work merged to repository label Dec 17, 2022
@weibullguy weibullguy removed the V: minor Bumps the minor version label Jan 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: stakeholder Relates to docformatter stakeholder requested behavior P: enhancement Feature that is outside the scope of PEP 257 S: merged Closed with work merged to repository
Projects
None yet
Development

No branches or pull requests

2 participants