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

Sylvain Thénault sylvain.thenault at logilab.fr
Thu Jul 31 08:10:58 CEST 2014


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


More information about the code-quality mailing list