Skip to content

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

@webknjaz

Description

@webknjaz

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    C: stakeholderRelates to docformatter stakeholder requested behaviorP: enhancementFeature that is outside the scope of PEP 257U: lowA relatively low urgency issue

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions