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

[Daniel, Bruno]

Hello Sylvain,
 
> great! One last thing: by adding your checker to pylint itself, we still hope
> that you'll maintain it :) 

Thanks, I'd love to! 
I'm also going to fix all the issues mentioned by the reviewers of the pull 
request soon.

Another question: We also use Cython code in our projects. It would be 
great to be able to check .pyx and .pxd files using pylint as well and maybe 
I could work on that. Has anyone else started working on this yet? 

Thanks again to be able to contribute!

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: Thursday, July 31, 2014 8:10 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 Daniel,

On 30 juillet 17:03, Daniel, Bruno wrote:
> 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.

great! One last thing: by adding your checker to pylint itself, we still hope
that you'll maintain it :) That mainly means answering to issues regarding your
checker that will ends up in pylint's tracker. You may still use pull requests
for fixes/enhancements, and if at some point you feel like having write access to
the repo would ease the job, ask us.

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