inspiringly documented projects

[Martin DeMello]

I was looking at Rubygame this morning, and I was impressed by the
quality of its documentation[1] - both extensive and coherent, with
notes as to the motivation behind various features. Prawn is another
such library I noticed recently. Anyone else have favourite examples?

[1] http://rubygame.sourceforge.net/doc/2.3.0/

martin

 

[Tom Cloyd]

I was looking at Rubygame this morning, and I was impressed by the
quality of its documentation[1] - both extensive and coherent, with
notes as to the motivation behind various features. Prawn is another
such library I noticed recently. Anyone else have favourite examples?

[1] http://rubygame.sourceforge.net/doc/2.3.0/

martin

My current nominees for this category (and seriously, there OUGHT to be
an award!) -

ERBook - Extensible document processor based on eRuby
http://snk.tuxfamily.org/lib/erbook/

Inochi - Gives life to RubyGems-based software
http://snk.tuxfamily.org/lib/inochi/#doc-theory.erb

This documentation is simply gorgeous!

t.

--

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Tom Cloyd, MS MA, LMHC - Private practice Psychotherapist
Bellingham, Washington, U.S.A: (360) 920-1226
<< (e-mail address removed) >> (email)
<< TomCloyd.com >> (website)
<< sleightmind.wordpress.com >> (mental health weblog)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~