On Thu, Jun 18, 2009 at 8:17 PM, Vishal <vsapr...@gmail.com> wrote: > If you run PyLint on any Python file...it gives you documentation > percentage of functions, methods, class, modules in your code tree. > it prints that out as a table. if you can scrap that info from the > resulting file...that should help as well... > basically it should be 100% for all the above..if not, someone needs to > complete the documentation. > > http://www.logilab.org/857 > > <http://www.logilab.org/857>please do remember that, PyLint depends on > two more packages from logilab. > uses logilab-astng <http://www.logilab.org/project/logilab-astng>, > logilab-common <http://www.logilab.org/project/logilab-common> > > > Hope this might be of some help. >
PyLint seems useful, however... > > As far as running tests are concerned: > It would be better if a test can get the __doc__ string, and search for > specific things in that string..such as 'input', 'output', 'description' and > make sure that these are not empty. How about enforcing that these > documentation strings should follow YAML format :)) > that should make it so much easier to examine them. > > __doc__ should be: > """ > - description: > blah, blah, blah > - Inputs: > blah, blah, blah > - output: > blah, blah, blah > """ > ..this is nicer since I can plug yaml right into PyYaml. Very nice suggestion. Thank you, Jayanth
_______________________________________________ BangPypers mailing list BangPypers@python.org http://mail.python.org/mailman/listinfo/bangpypers
