[Biopython-dev] Documentation

Peter biopython at maubp.freeserve.co.uk
Thu Jul 15 15:38:24 UTC 2010


On Thu, Jul 15, 2010 at 4:22 PM, Vince S. Buffalo <vsbuffalo at gmail.com> wrote:
>>
>>  I think the docstrings should be the primary API documentation,
>>  and the Tutorial the primary introductory text.
>
> I like the idea of code and documentation living together, but one thing
> that concerns me is that as the documentation grows larger and filled with
> more examples, it may begin to clutter the code quite a bit.

We can cross that bridge if we come to it - right now I would say most
modules really need more docstrings. If you think that any of the docstrings
you've looked at are too long, we can discuss shortening them (ideally by
relocating good content or tests).

Peter




More information about the Biopython-dev mailing list