[Biopython-dev] Why don't we start the documentations as well?

[Yair Benita]

I guess its also fine, I don't have a preference as long as we get started
on that. What do you think Jeff?
Yair

on 1/7/02 9:31, Thomas Hamelryck at thamelry at vub.ac.be wrote:

> [...]
> 
>> For example, Once somebody learned how to use
>> BioPython and wants to use HMMs where does he go?
> 
> The HMM module was not Happy Doc'ed for some reason. If it was, you would
> have a list of classes & methods etc. and a lot of documentation. I checked
> in the source code - it contains a lot of info. Simply applying Happy Doc
> would make that information readily available. I do not see any advantage in
> generating that info manually. Or am I missing something?
> 
>> Currently he has to go to the source code
> 
> No, you can check the API documentation generated with Happy Doc:
> 
> http://www.biopython.org/wiki/html/BioPython/BiopythonCode.html
> 
>> if we give him a reference he can simply look at the
>> classes, the different methods and understand how it works.
> 
> Again, that list of classes and methods and a description of what they do and
> return can be generated automatically with Happy Doc.
> 
> But maybe you are thinking of some kind of templated tutorial model? That
> would be useful IMO. In many cases a simple enumeration of classes & methods
> is not enough to use the package efficiently, so you need more.
> 
> Cheers,
> 
> -Thomas
> _______________________________________________
> Biopython-dev mailing list
> Biopython-dev at biopython.org
> http://biopython.org/mailman/listinfo/biopython-dev
>