<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Fri, Jul 12, 2013 at 6:11 PM, Terry Reedy <span dir="ltr"><<a href="mailto:tjreedy@udel.edu" target="_blank">tjreedy@udel.edu</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im">On 7/12/2013 10:22 AM, L O'Shea wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Hi all, I've been asked to take over a project from someone else and<br>
to extend the functionality of this. The project is written in Python<br>
which I haven't had any real experience with (although I do really<br>
like it) so I've spent the last week or two settling in, trying to<br>
get my head around Python and the way in which this code works.<br>
</blockquote>
<br></div>
If the functions are not documented in prose, is there a test suite that you can dive into?<span class="HOEnZb"><font color="#888888"><br>
<br>
<br>
-- <br>
Terry Jan Reedy<br>
<br>
-- <br>
<a href="http://mail.python.org/mailman/listinfo/python-list" target="_blank">http://mail.python.org/<u></u>mailman/listinfo/python-list</a><br>
</font></span></blockquote></div><br></div><div class="gmail_extra">I'm very appreciative of pydoc. -- even for code I write myself!.  Learn about it and redirect its output to files, so you can print out all of your modules.  (well -- my suggestion!).  For the functions and classes that are lacking docstrings, review them and see if you can figure out what they do.  Add docstrings.. <br>
<br></div><div class="gmail_extra">Not to disrespect this original coder in the slightest, but my work experience has been involved in reading and fixing or updating lots of other peoples code -- most less documented than would be nice.  So my def of good code is code with good descriptive docstrings -- at the top level even before documenting the details.  Its nice to know where the developer's head was at when the system was put together.<br clear="all">
</div><div class="gmail_extra"><br>-- <br><div dir="ltr"><div>Joel Goldstick<br></div><a href="http://joelgoldstick.com" target="_blank">http://joelgoldstick.com</a><br></div>
</div></div>