flake8-docstrings-complete has added new rules that ensure you only document each argument, raised exception and class attribute once:
Continue reading “flake8-docstrings-complete Now Checks for Duplicate Descriptions” →
DCO025: function/ method has one or more arguments described in the docstring multiple times.
DCO056: function/ method has one or more exceptions described in the docstring multiple times.
DCO065: class has one or more attributes described in the docstring multiple times.
Have you ever encountered an error when using a package and then gone to Google to find out how to solve the error only not to find any clear answers? Wouldn’t you have preferred to go directly to documentation that tells you exactly what went wrong and how to resolve that error? A lot of us can tell similar stories, especially when we try something new. I have also abandoned an otherwise promising package after encountering an error that wasn’t clear or when I didn’t know how to solve the error.
Continue reading “Help your Users fix your Errors” →