Hello,<br><br>I am currently thinking about enforcing the following standard for a small demo project that might evolve into something larger pending approval(which was why the request for training programmes).<br><br>Every module, every class and every function should have documentation. To enforce this, I write a unit test that basically does something as follows:<br>
<br>undocumented = [obj for obj in dir(module) if obj.__doc__ == None]<br>assertEqual (undocumented, [])<br><br>Of course, I&#39;d have to make it recursive for all classes defined in module etc. I just wanted to know what people thought of this and whether somebody else has experiences with such a standard being enforced and what they think the pros/cons might be?<br>
<br>Thank you,<br><br>Jayanth<br><br><br><br>