On 03/09/2015 07:40 AM, Zach Welch wrote:
On 03/09/2015 06:52 AM, Dan Smith wrote:
diff --git a/chirp/drivers/__init__.py b/chirp/drivers/__init__.py index ea9dd2c..c4b10ce 100644 --- a/chirp/drivers/__init__.py +++ b/chirp/drivers/__init__.py
...
+""" +Contains all of the CHIRP driver modules. +"""
I'm really -1 on requiring (and adding, for that matter) completely useless docstrings to files and functions just because pylint says to. It's just noise.
Docstrings on legitimate interface methods that actually contribute useful documentation to a user are one thing. A docstring above $thing that says "this is $thing" is not useful.
I agree that many of the module-level docstrings that I added need improvement, but their presence serves as a reminder to add more information down the road.
I'd also like to point out that the pydoc output is much cleaner for those modules, even if it only is a single line. Without module-level docstrings, pydoc outputs the copyright header block, which is not informative at all.
In other words, these changes don't just make pylint happy, they make pydoc's output look better too.