HackWeek Summary - Jonathan Pryor's web log
« Announcing NDesk.Options 0.2.0 | Main | Threading: Lock Nesting »
HackWeek Summary
In case you missed it, last week was "Hackweek" at Novell.
My week was less "hacking" and more "spit-and-polish." In particular:
- Wrote Mono.Unix.UnixSignal documentation. This only took ~1/2 a day.
- Released NDesk.Options 0.2.0, which in turn involved the
vicious cycle
of write documentation (and samples), realize I'm missing something or don't
like the name, change the library, update the documentation, repeat...
Consequently, something I thought would only take another half a day wound up taking 3 days, with some changes happening at the last moment (the System.Action`2 removal, thus removing the need to have two different builds depending on whether .NET 2.0 or .NET 3.0 is targeted).
- Improve monodocs2html so that the output sucks...well, less. I won't say
that it's actually good now, but it is an improvement. For comparison
purposes, NDesk.Options.OptionSet documentation output from:
In particular, note that in the 1.2.6 output that there are three examples as part of the Remarks documentation, but it's rather difficult to tell when one example ends and the next begins (due to the lack of an Example header). The svn version fixes this, adds JavaScript bling so that all sections can be collapsed and expanded, and adds a mini "index" to the top-left so that it's easier to get to the relevant sections (such as skipping the three lengthy examples that precede the Members listing).
I had wanted to do other things as well, such as migrate the monodoc-related programs to use NDesk.Options instead of Mono.GetOptions for option parsing, but such efforts will have to wait until later...
blog comments powered by Disqus