3 ms·
If nothing else it may have improve documentation. The API docs are generated from comments in the code. To fix or add to the docs you need to get the source
by jamesbritt 17y ago
If nothing else it may have improve documentation.
The API docs are generated from comments in the code. To fix or add to the docs you need to get the source from svn, add your stuff, make a diff patch, and submit that patch to the ruby-doc or ruby-core mailing lists.
I've done it, its not that hard, but it's sort of tedious, and annoying enough that people who might otherwise want to help by adding a few notes or fixing the examples just won't.
Maybe I've just gotten used to it, but the use of git and github for this seems much simpler.
- jeremymcanally 17y agoI agree. There are a lot of things just simply wrong in the Ruby documentation but it's such a hassle to patch it that I haven't put in the effort to fix them. :(