search

diminish7 / rave

A Google Wave robot client framework for Ruby
http://github.com/diminish7/rave
MIT License
62 stars 8 forks source link

Sort out rdoc #16

Closed bil-bas closed 14 years ago

bil-bas commented 14 years ago

I think the rdocs could be a useful resource for users, but is rather too cluttered with irrelevant junk.

I've sort of half-heartedly added :nodoc: to internal methods, so they won't be seen in the API documentation, but I need to go through the lot and ensure that everything that a user doesn't need won't be shown (e.g. whole Operation class).

Something I'd like to be able to do, however, is mark some methods as accessors, since that is what they logically are, but since they are created manually, rather than with attr_*, rdoc doesn't catalogue them correctly. If you know how to do this, please tell me. I'm sure there must be a way to do this, but I'm struggling to find decent information on advanced rdoc.

bil-bas commented 14 years ago

Done most of this, which makes the rdoc a lot more manageable for users, I think. There is a way to "fake" the accessors, which I guess I can do when I get around to it.

Need to clearly mark the methods which are not yet implemented too. Easier than people trying them only to get NotImplementedError breaking their nice bots on the live site.

bil-bas commented 14 years ago

This should be complete now, but maybe needs checking to see if anything should be in that isn't or should be out and is in. Or anything needs expanding on.

bil-bas commented 14 years ago

Done. Any new stuff just needs to be added to rdoc properly too keep it consistent. Maybe also a bit more detail on general usage might be useful.