[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [IMP-dev] module descriptions

yes, it is extremely useful to have a small example of a few lines in
each class.
maybe not each class, but at least in the major functional classes.
class description is not always enough and an example shortens the
time you need to get from class description to usage.

On Tue, Nov 25, 2008 at 3:18 PM, Daniel Russel <> wrote:
> Dina Schneidman wrote:
>> I think that what I miss most is some basic usage example for the most
>> important classes...
> We have the introduction.dox and the two examples (doc/example) which
> give some such examples. Would it be useful to have a little few line
> example in the doc of each class? Or do you already know to use the
> class by the time you get to the class description?
> _______________________________________________
> IMP-dev mailing list
> https://salilab.org/mailman/listinfo/imp-dev