search

terrencepreilly / darglint

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

Add an option to support printing explanation of error code #145

Closed dclong closed 3 years ago

dclong commented 3 years ago

The error message is too short and might be confusing for users who are not very familiar with the error codes. Printing explanation of error code helps.

terrencepreilly commented 3 years ago

The README gives instructions on setting the verbosity of error codes (darglint -v 2). It also explains how to format custom error messages (darglint --message-template ...). And there is an option to list all errors, with explanations (darglint --list-errors.) I think there are plenty of options for anyone looking for more information.