From: Mark U. <ma...@cs...> - 2007-10-15 20:04:23
|
Tim Miller wrote: > I've already added code snippets for running the parser and > typechecking to the wiki page: > http://czt.wiki.sourceforge.net/Examples > > I think that this is definitely where such things should go, so > that developers outside of the project can add their own code > snippets if they think they'll be useful. > I agree that it will be really useful to build up a collection of small "FAQ code snippets" like this. Putting them in the wiki has the advantage that non-CZT-developers can add their snippets, but the (big!) disadvantage that those snippets will not have their unit tests run as part of the usual CZT tests. I think it is *really* important that we maintain these snippets. So having their unit tests run frequently is important. Also, I often use the "Find all references" tool of Eclipse to find all callers of a given method and update them all -- this is only possible if those snippets are in the CZT repository. So I'd like to have an area in the doc project for code snippets (plus unit tests that do a smoke test on each snippet). Plus a web page there that gives a brief overview of the snippets. Any ideas on how we could combine the benefits of the wiki approach with the 'regular unit testing' approach? Mark |