econchick / interrogate

Explain yourself! Interrogate a codebase for docstring coverage.
https://interrogate.readthedocs.io
MIT License
562 stars 46 forks source link

Inconsistency for default values in documentation #139

Closed VDuchauffour closed 3 months ago

VDuchauffour commented 1 year ago

Description of the bug

It seems that documentation contains inconsistency about ignore-init-method and ignore-nested-classes in configuration section and command line options. Command line options seems to match to default values here (i.e. set on False) while the configuration section indicates that they are set to True by default. I guess if this error is correct, it is required to modify the README.rst file? Thanks

econchick commented 3 months ago

Thanks! fixed