Pylint - missing module docstring for __init__.py
This warning seems specious: __init__.py:1: [C0111] Missing module docstring especially since __init__.py is often empty (as it is in this case), being used only as a marker that a directory is actually a package. This is in Python 2.7. I'm doing nothing to override the docstring_min_length config parameter, so if my reading of DocStringChecker._check_docstring is correct, this message should not be emitted for any zero-length module. I can't tell where/how self.config.docstring_min_length is initialized (find+grep doesn't return many hits), so can't tell what its value is, either. (Well, not without inserting a print statement.) What am I missing here? Skip
Hi Skip, On 02 juillet 09:29, Skip Montanaro wrote:
This warning seems specious:
__init__.py:1: [C0111] Missing module docstring
especially since __init__.py is often empty (as it is in this case), being used only as a marker that a directory is actually a package. This is in Python 2.7. I'm doing nothing to override the docstring_min_length config parameter, so if my reading of DocStringChecker._check_docstring is correct, this message should not be emitted for any zero-length module. I can't tell where/how self.config.docstring_min_length is initialized (find+grep doesn't return many hits), so can't tell what its value is, either. (Well, not without inserting a print statement.)
What am I missing here?
docstring_min_length is initialized from the docstring-min-length option. IIRC, this is only considered for functions / methods though, and I agree that it should be considered for modules (classes?) as well. If you don't have time to submit a patch, please consider opening an issue on bitbucket. Thanks! -- Sylvain Thénault, LOGILAB, Paris (01.45.32.03.12) - Toulouse (05.62.17.16.42) Formations Python, Debian, Méth. Agiles: http://www.logilab.fr/formations Développement logiciel sur mesure: http://www.logilab.fr/services CubicWeb, the semantic web framework: http://www.cubicweb.org
participants (2)
-
Skip Montanaro -
Sylvain Thénault