[Biopython-dev] epydoc formatting in Bio.Phylo
Eric Talevich
eric.talevich at gmail.com
Sun Apr 4 14:12:19 UTC 2010
On Sat, Apr 3, 2010 at 9:00 AM, Peter <biopython at maubp.freeserve.co.uk>wrote:
> Hi Eric,
>
> One of the tasks in building a release which I am only doing now is
> updating the API docs:
> http://biopython.org/wiki/Building_a_release
>
> Using epydoc can raise warnings about errors in the code (usually
> things like broken imports) which means it doubles as a code check.
> The code news is I don't see any such issues (beyond existing name
> shadowing which we are stuck with).
>
> However, this has flagged a few things in Bio.Phylo, most of which
> look like documentation formatting issues since you have explicitly
> stated you are using the epydoc markup [...]
>
OK, I fixed the docstrings for epydoc (and a few other things) and pushed to
GitHub. It should be all right now.
Thanks,
Eric
More information about the Biopython-dev
mailing list