[Biopython-dev] [Bug 2640] Proposal: doctest for SeqRecord/biopython

[bugzilla-daemon at portal.open-bio.org]

http://bugzilla.open-bio.org/show_bug.cgi?id=2640


biopython-bugzilla at maubp.freeserve.co.uk changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|RESOLVED                    |REOPENED
         Resolution|FIXED                       |




------- Comment #16 from biopython-bugzilla at maubp.freeserve.co.uk  2008-11-12 06:47 EST -------
(In reply to comment #15)
> I saw the changes now!

The CVS website is updated once an hour, you track this on
http://biopython.org/wiki/Tracking_CVS_commits which displays the RSS feed,
http://biopython.open-bio.org/CVS2RSS/biopython.rss (this works great apart
from the links when more than one file is changed).

> ok.. But I would prefer to put the doctest in the main __doc__ of
> the function instead of __init__ and __repr__.
> This is because otherwise they wouldn't be accessible by the users with the
> help function.  Usually you do help(SeqRecord), not help(SeqRecord.__init__).

If you do help(object) it shows you the main docstring followed by all the
methods and their docstrings (including __init__).

On the other hand all the special methods like __init__, __str__, __repr__ etc
are going to be confusing for a beginner.

On balance, a short example in the main docstring (covering __init__) does seem
sensible, and perhaps the __init__ example is then redundant.

Does anyone else want to comment?


-- 
Configure bugmail: http://bugzilla.open-bio.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.