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

Adapt comments into RDoc convention #29

Open
ErvalhouS opened this issue Nov 19, 2018 · 0 comments
Open

Adapt comments into RDoc convention #29

ErvalhouS opened this issue Nov 19, 2018 · 0 comments
Labels
documentation Enhancements on documentations or wikis

Comments

@ErvalhouS
Copy link
Contributor

We already have an OK documentation present on the comments across the projects' files. This is fine, but RDoc pages are being generated with poorly formatted examples and some of the examples across the code are not being placed where it should.

This is very visible at our Ability docs, which has fine examples, but they are very badly placed. Other examples are being poorly formatted, like the ones on the CRUD Controller endpoints.

This should be fixed for a better documentation.

@ErvalhouS ErvalhouS added the documentation Enhancements on documentations or wikis label Nov 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Enhancements on documentations or wikis
Projects
None yet
Development

No branches or pull requests

1 participant