For what it's worth, I think this is a fabulous idea!
Having the snippets online are helpful for "window shoppers" who are trying to decide whether to "jump in". But keeping the online docs in sync with the source tree will probably take additional time that is probably spent elsewhere. Also, if you overwrite the online docs everytime the API changes, those who have already committed to working with an older version can loose their documentation. Putting snippets in the distribution, especially if they are accompanied by actual code in .java, .sld, .xml, etc. format, the learning curve for newbies would be eased. Once someone downloads a distribution and starts working with it, having the snippets and tutorials on the local machine is more convenient than having them online (at least for me - I'm still on dialup). Just my two cents! Todd --- [EMAIL PROTECTED] wrote: > Hello Andrea, > > Users have to be able to get the snippets for the > version they are > working with. Maybe you should not have snippets > online. Maybe the > snippets should be included in the distribution. > > If you do want to have snippets online, then it > should be clearly > indicated with which version of geotools (and jdk) > each snippet was > tested. > > Cheers, Arjan. > > > > It seems easy enough to catch errors in snippets > after code changes: > > > just include them in the source tree. Whoever > makes a change to the > > > geotools code, is responsible for keeping > everything else working > > > properly, including the snippets. > > > > Heh, not as immediate as it sounds thought: the > developers would > > certainly fix the snippet in the source code, but > then you have to > > find the online article and update it as well. And > maybe create a > > new one, since the change may be relevant to a > developer version > > of the code, whilst the online docs refer the > released version of > > the library... > > > > Best regards > > Andrea Aime > > > > > > > ***PRIVILEGED AND CONFIDENTIAL*** > The information contained in this e-mail message > (including any attached files) > is intended for the use of the addressee(s) only and > is privileged information. > The information should neither be posted to the > Internet, nor published in any > other public domain, without the express permission > of the sender. If you are > not the intended recipient(s) or the recipient's > representative, you are hereby > notified that any use, disclosure, copying or > distribution of this communication > is prohibited. If you have received this > communication in error please notify us > immediately at [EMAIL PROTECTED], and remove > this message from > your system. > > > ------------------------------------------------------- > This SF.Net email is sponsored by: > Power Architecture Resource Center: Free content, > downloads, discussions, > and more. > http://solutions.newsforge.com/ibmarch.tmpl > _______________________________________________ > Geotools-gt2-users mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/geotools-gt2-users > The only "dumb question" is the one you were too afraid to ask. ________________________________________ Check out RouteRuler - Free software for runners, cyclists, walkers, etc. http://routeruler.sourceforge.net ________________________________________ Get a handle on your data with "pocOLAP", the "little" OLAP project http://pocolap.sourceforge.net ________________________________________ __________________________________ Yahoo! Music Unlimited Access over 1 million songs. Try it free. http://music.yahoo.com/unlimited/ ------------------------------------------------------- This SF.Net email is sponsored by: Power Architecture Resource Center: Free content, downloads, discussions, and more. http://solutions.newsforge.com/ibmarch.tmpl _______________________________________________ Geotools-gt2-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/geotools-gt2-users
