search

OzFramework / oz

Oz is a behavioral web-ui testing framework developed to reduce test maintenance by using a predictive model rather than a scriptive model when writing tests.
Apache License 2.0
23 stars 7 forks source link

RDoc for CORE #127

Open PanoramicPanda opened 6 years ago

PanoramicPanda commented 6 years ago

Create RDoc documentation for CORE Methods such as world, elements, pages, ledger, and logger.

Castone22 commented 5 years ago

While documentation for CORE would be nice, i don't necessarily think we should use RDocs for it. I'd personally prefer to have a good suite of unit tests and then from that generate docs using a tool like relish.

The problem with manually written documenters like RDoc is that they frequently fall out of spec with the things that they describe. (there's NOTHING worse than a magic comment that says it does something completely different than what the code under it actually does.) At least if you generate your docs from unit and integration tests then you get a notification when this happens.