Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RDoc for CORE #127

Open
PanoramicPanda opened this issue Sep 6, 2018 · 1 comment
Open

RDoc for CORE #127

PanoramicPanda opened this issue Sep 6, 2018 · 1 comment

Comments

@PanoramicPanda
Copy link
Member

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

@Castone22
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants