APIcasso icon indicating copy to clipboard operation
APIcasso copied to clipboard

Adapt comments into RDoc convention

Open ErvalhouS opened this issue 7 years ago • 0 comments

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 avatar Nov 19 '18 19:11 ErvalhouS