[code-quality] Contribution: Checking function, method, and constructor parameter documentation

[Daniel, Bruno]

Dear Sylvain Thénault and Dougal Matthews,

I just added a pull request for the discussed checker:

https://bitbucket.org/logilab/pylint/pull-request/143/new-extensions-directory-new-optional/diff

As you suggested, I created a new module for such optional checkers:

    pylint/extensions

containing the following files (so far):

    __init__.py
    check_docs.py

I put the test file for the new checker into the normal test directory:

    pylint/test/test_check_docs.py
 
People can activate this new checker by adding the line 

    load-plugins=pylint.extensions.check_docs

to the MASTER section of their .pylintrc . 

I added more documentation (including this usage description) to the class docstring
of the checker. 

Kind regards
    Bruno Daniel


Dr. Bruno Daniel
Research and Development
Blue Yonder GmbH
Ohiostraße 8
D-76149 Karlsruhe

Tel +49 (0)721 383 117 80
Fax +49 (0)721 383 117 69

bruno.daniel at blue-yonder.com
www.blue-yonder.com
Registergericht Mannheim, HRA 701753
USt-IdNr. DE 259 967 448
Geschäftsführer: Jochen Bossert, Uwe Weiss (CEO)


________________________________________
From: sylvain.thenault at logilab.fr [sylvain.thenault at logilab.fr]
Sent: Friday, July 25, 2014 9:13 AM
To: Daniel, Bruno
Cc: Dougal Matthews; code-quality at python.org
Subject: Re: [code-quality] Contribution: Checking function, method, and constructor parameter documentation

Hello guys,

this sounds like a very nice and useful checker indeed. I know there are some
others like this one around (eg django dedicated checker, i18n/gettext checker,
probably more). Rather to include them all in the pylint source distribution, I
think what's missing is some official page listing such plugins. Or we could
indeed also ship pylint with an "extensions" directory containing such
additional checkers. What would be your preferred way ?

--
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