<br><br><div class="gmail_quote">On Thu, Jun 18, 2009 at 8:17 PM, Vishal <span dir="ltr"><<a href="mailto:vsapre80@gmail.com">vsapre80@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
If you run PyLint on any Python file...it gives you documentation percentage of functions, methods, class, modules in your code tree.<div><br></div><div>it prints that out as a table. if you can scrap that info from the resulting file...that should help as well...</div>
<div>basically it should be 100% for all the above..if not, someone needs to complete the documentation.</div><div><br></div><div><a href="http://www.logilab.org/857" target="_blank">http://www.logilab.org/857</a></div><div>
<br></div><div>
<a href="http://www.logilab.org/857" target="_blank"></a>please do remember that, PyLint depends on two more packages from logilab. </div><div><span style="font-family: 'Trebuchet MS'; font-size: 12px; border-collapse: collapse;"><span style="margin: 0px; padding: 0px 1em 0px 0px; font-weight: bold;">uses</span><div style="margin: 0px 0px 0px 0.2em; padding: 0px; display: inline;">
<a href="http://www.logilab.org/project/logilab-astng" title="The aim of this module is to provide a common base..." style="margin: 0px; padding: 0px; color: rgb(255, 69, 0); text-decoration: none;" target="_blank">logilab-astng</a>, <a href="http://www.logilab.org/project/logilab-common" title="Please note that some of the modules have some ext..." style="margin: 0px; padding: 0px; color: rgb(255, 69, 0); text-decoration: underline;" target="_blank">logilab-common</a></div>
</span><br><br></div><div>Hope this might be of some help.</div><div></div></blockquote><div><br>PyLint seems useful, however...<br> </div><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
<div><br></div><div>As far as running tests are concerned:</div><div>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 :))</div>
<div>that should make it so much easier to examine them.</div><div><br></div><div>__doc__ should be:</div><div>"""</div><div>- description:</div><div> blah, blah, blah</div><div>- Inputs:</div><div> blah, blah, blah</div>
<div>- output:</div><div> blah, blah, blah<br>"""</div><div></div></blockquote><div><br><br>..this is nicer since I can plug yaml right into PyYaml. <br><br>Very nice suggestion.<br><br></div></div>Thank you,<br>
<br>Jayanth<br>