Skip to content

Adapt comments into RDoc convention #29

@ErvalhouS

Description

@ErvalhouS

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationEnhancements on documentations or wikis

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions