-
Notifications
You must be signed in to change notification settings - Fork 192
Open
Milestone
Description
As we want to be a nice easy to use toolkit we need documentation. Lots of it.
- Write rdoc for classes/public methods
- Appropriately mark private methods as such so they are not included in the rdoc
- Update the manual
- Ensure Yard generation to http://www.rubydoc.info/github/shoes/shoes4 is looking 👌
This is mostly here to remind us of it for rc1 4.0. Some methods already have rdoc comments which is great 👍
The most important thing to document is the DSL module.
As a side note, I'm on the pro side of code should be so readable that it does not need comments. Documentation, especially for a library is different though. Especially a beginner library. Lots of people out there wouldn't even dare to look at source code to see how something works - I was just like that when I started and years after that. And people shouldn't have to do that. Good up to date documentation is vital to the success of a project imo.