On 08/12/2011 10:28 AM, Nicolas Chauvat wrote:
> Hi Gelonida,
> 
> On Thu, Aug 11, 2011 at 09:49:25AM +0200, Gelonida N wrote:
>> Additionally it might have helped of course if the official web site
>> (being marked as updated 8th of August 2011) had not mentioned a command
>> (pylint.lint.run_py), that I couldn't find
> 
> http://hg.logilab.org/pylint/file/511d09d223c8/doc is the current head
> of the mercurial repository. I copied that documentation to the web
> site a couple days ago.
> 
> If you see mistakes in that documentation:
> - please report them to this list,

Will do next time.

In a few simple sentences:
The doc does not mention
pylint.lint.Run() as option to rum pylint from within a script.

On the other hand it mentions pylint.int.run_py, which doesn't exist
anymore.

pylint.epylint.run_py() exists, but has a different  output format than
running pylint from the command line.


> - or better yet, attach a patch to your report,

I'm not exactly sure how to best 'fix' the issue.

Probably bewst would be to mention:
pylint.lint.Run() and pylint.epylint.run_py() and explain the intended
use cases.

Further it might be nice to give an example of how to receive pyilints
output as a string.

I posted what I came up with in another thread.
I'm not sure whether this is really the most elegant way.


> - or even better clone http://hg.logilab.org/patches/pylint/, commit your
>   patch into that repo, make the repo available online and send us a
>   pull request with your report.

Well perhaps it's a nice excuse to make first tests with hg. So far I
used only git.

Is there anything like github for hg?
Oherwise I had difficulties to make the repo available online.

> 
> As most of you know, pylint is developed in the open at
> http://www.logilab.org/project/pylint where you'll find tickets, bugs,
> etc and the patches being worked on are visible at
> http://www.logilab.org/project/pylint?tab=vcreview_patches_tab

> We have been trying to make it easier for everyone to contribute to
> pylint, even occasionnaly, please let us know if we can further improve
> things.
> 

Just a tiny suggestion:

Of course one can google for it, but perhaps this might reduce the
'barrier' for contributors not knowing hg.
A short l document explaining the minimalist flow of
how to checkout  the repository (found it in the section source code of
the pylint web site)
how to fix,
how to commit,
how render public a repo
and perhaps one link to a more complete hg doc.


> Cheers,
> 
Thanks for your answer

_______________________________________________
Python-Projects mailing list
[email protected]
http://lists.logilab.org/mailman/listinfo/python-projects

Reply via email to