search

terrencepreilly / darglint

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

Add message template option for decoded error. #174

Closed krisrave closed 3 years ago

krisrave commented 3 years ago

Please add the option in the message template to add the decoded version of each error. My desired output is something like the following.

.\foo_bar\foo.py:test_func:3 DAR201 - The docstring is missing a return from definition.

Currently the only option available is:

.\foo_bar\foo.py:test_func:3 DAR201 - return

This format doesn't give a good enough description to those that aren't familiar with the error codes.

krisrave commented 3 years ago

Hadn't checked the verbosity options.