For an eventual IMP release, each module needs some sort of description page giving an overview of the module. I checked in files modules/core/src/core.dox (and a misc version) which provide a first crack at this. So far the page contains: - an overview which includes the namespace containing the code - a list of authors - a list of publications to cite when using the code - the license that the code is released under
Anything more that should go in there?
I think that what I miss most is some basic usage example for the most important classes...
On Tue, Nov 25, 2008 at 3:03 PM, Daniel Russel drussel@gmail.com wrote: > For an eventual IMP release, each module needs some sort of description > page > giving an overview of the module. I checked in files > modules/core/src/core.dox (and a misc version) which provide a first > crack at this. So far the page contains: > - an overview which includes the namespace containing the code > - a list of authors > - a list of publications to cite when using the code > - the license that the code is released under > > Anything more that should go in there? > _______________________________________________ > IMP-dev mailing list > IMP-dev@salilab.org > https://salilab.org/mailman/listinfo/imp-dev >
I totally agree with this. We need more example, and easy tutorials for the public (like Modeller's) !!
Dina Schneidman wrote: > I think that what I miss most is some basic usage example for the most > important classes... > > On Tue, Nov 25, 2008 at 3:03 PM, Daniel Russel drussel@gmail.com wrote: > >> For an eventual IMP release, each module needs some sort of description >> page >> giving an overview of the module. I checked in files >> modules/core/src/core.dox (and a misc version) which provide a first >> crack at this. So far the page contains: >> - an overview which includes the namespace containing the code >> - a list of authors >> - a list of publications to cite when using the code >> - the license that the code is released under >> >> Anything more that should go in there? >> _______________________________________________ >> IMP-dev mailing list >> IMP-dev@salilab.org >> https://salilab.org/mailman/listinfo/imp-dev >> >> > _______________________________________________ > IMP-dev mailing list > IMP-dev@salilab.org > https://salilab.org/mailman/listinfo/imp-dev >
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?
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 drussel@gmail.com 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 > IMP-dev@salilab.org > https://salilab.org/mailman/listinfo/imp-dev >
-
Daniel Russel -
Dina Schneidman -
Seung Joong Kim