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 ignore_raise parameter to ignore common exceptions #151

Closed palt0 closed 3 years ago

palt0 commented 3 years ago

Closes #144.

Exceptions listed in ignore_raise don't need to be listed in the Raises section of a docstring. Of course, if an user explicitly chooses to include an ignored exception in a docstring, other correlated errors such as ExcessRaiseError can still apply.

terrencepreilly commented 3 years ago

Looks great, thanks for the contribution!