I decided that Chris Henry has the best API documentation (http://140.221.84.191/services/docs/workspaceService/workspaceService.html). He gives a good overview of the services, including *why* you might use it as well as how. He included an example of how you'd use the API from a perl program. And he documented every variable and method. Furthermore, he generated his API docs in the currently approved standard KBase way, by putting comments in the typespec. I looked at a few API docs that were very nice-looking, but were not generated the standard way. Overall, the API docs are looking pretty good. There are a few that are not showing up on http://140.221.84.191/services/docs that should be, which seems like it may be due to some sort of deploy issue. But a lot more services have API docs now than did in November. I gave the Star Wars X-Wing Ice Cube Tray to Andreas to bring back to ANL for Chris. Nomi On Feb 3, 2013, at 2:39 PM, Thomas Brettin <[email protected]> wrote:
Elizabeth was so kind as to pony up some prizes on behalf of outreach for this build :-)
Here is what we came up with for categories--
The module that has the best test coverage of their service as determined by Miriam
Prize: Chewbacca MimoMicro USB Drive & Reader
Best technical API documentation as determined by Nomi
Star Wars X-Wing Ice Cube Tray
Best command line user documentation as determined by Paramvir
Doctor Who Dalek Tumbler
Tom