I completely agree, the API documentation is equivalent to looking at
header files.
I can suggest the following to enhance it:
1. we should have a description of the logic behind imp: how
"representation, scoring, optimization" is translated to imp classes,
what is the data flow (ScoreStates, Restraints) during optimization,
how to setup your system accordingly.
A similar description can exist for specific IMP modules.
2. Each class should contain explanation including it's goals, where
it is used and a small usage example. This info should go into the
API, to make it more useful.
Dina
2009/3/26 Javier Ángel Velázquez Muriel <>:
>
> Hi everybody,
>
> This days, as I use more and more the IMP API documentation and get more
> familiar with it, I feel that is extremely simple, rather useless if you
> don't know about the class you're using and the internal mechanisms, or
> somebody introduce you to it. Probably it also applies to my small
> contributions to the package, but I would like to raise my hand as one that
> would enjoy some effort (and I am willing to take the advice too) from the
> rest of the developers when documenting.
>
> Thanks
> Javi
>
> _______________________________________________
> IMP-dev mailing list
>
> https://salilab.org/mailman/listinfo/imp-dev
>
>