search

best-doctor / flake8-annotations-coverage

flake8 plugin to validate annotations coverage
MIT License
34 stars 5 forks source link

Missing help text in options #2

Open sobolevn opened 5 years ago

sobolevn commented 5 years ago

It is a good practice to use help attribute for options. This way all options will be documented when running flake8 --help. It is also a good practice to use a default value in the description.

That's how I do it: https://github.com/wemake-services/wemake-python-styleguide/blob/master/wemake_python_styleguide/options/config.py#L15-L29

Melevir commented 4 years ago

This is still legit.