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

[FR][UX] Dedicated config location possibility: .docformatter.toml #212

Open
webknjaz opened this issue May 18, 2023 · 0 comments
Open

[FR][UX] Dedicated config location possibility: .docformatter.toml #212

webknjaz opened this issue May 18, 2023 · 0 comments
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

Comments

@webknjaz
Copy link

With some on-scale maintenance workflows, it's important to be able to put different tool configurations in their own config files. Like .flake8 or towncrier.toml.
One of such workflows is https://blog.jaraco.com/skeleton/, for example.

With the above in mind, I'd like to suggest adding support for a tool-specific config. It could be, for example, .docformatter.toml (I would be fine with just .docformatter and ini-parser but a lot of people prefer TOML these days).

I understand that it's possible to use --config with whatever filename I like but this would require passing it everywhere if the tool is to be used from different environments (like pre-commit and various editors). Doing so adds to the maintenance burden, while this FR's motivation is to reduce it.

@github-actions github-actions bot added the fresh This is a new issue label May 18, 2023
@weibullguy weibullguy added P: enhancement Feature that is outside the scope of PEP 257 C: stakeholder Relates to docformatter stakeholder requested behavior and removed fresh This is a new issue labels May 18, 2023
@weibullguy weibullguy added this to the v2.0.0 milestone May 19, 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
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 U: low A relatively low urgency issue
Projects
None yet
Development

No branches or pull requests

2 participants