search

terrencepreilly / darglint

A python documentation linter which checks that the docstring description matches the definition.
MIT License
481 stars 41 forks source link

pyproject.toml configuration? #130

Open ericmjl opened 3 years ago

ericmjl commented 3 years ago

Hi @terrencepreilly! Firstly, I wanted to chime in to say thank you for making darglint. It's a great addition to the ecosystem :smile:.

Speaking of the ecosystem, I'm wondering if you might have considered allowing darglint to use a pyproject.toml file as the configuration file? This could be a nice thing to have, given that the Python world seems to be converging on it. On the pyjanitor project, we do have a pyproject.toml file that houses configuration for black and interrogate, and in other projects I have housed isort configuration in there too.

No pressure to push things in this direction, I was just wondering if this might be on your roadmap, and thought of dropping in to ask. Please feel free to close the issue at your convenience too!

terrencepreilly commented 3 years ago

That seems reasonable to support. Not sure exactly when I'll get around to it, but I'll update this at that time.

ssbarnea commented 3 years ago

I would really appreciate if this would become a reality as I feel my poor projects assaulted by too many config files at the root level. While I do not have a particular love for TOML format itself, I do like the idea of avoiding creation of yet another config file.

dobraczka commented 3 years ago

If you want darglint integrated with flake8 (which does not accept pyproject.toml) you can use https://github.com/csachs/pyproject-flake8 and then configure darglint via the [tool.flake8] table.