autoforce / autoforce/APIcasso
Adapt comments into RDoc convention
- Langage dominant
- Ruby
- Étoiles
- 31
- Forks
- 1
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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](https://www.rubydoc.info/gems/apicasso/0.4.11/Apicasso/Ability), which has fine examples, but they are very badly placed. Other examples are being poorly formatted, like the ones on the [CRUD Controller endpoints](https://www.rubydoc.info/gems/apicasso/0.4.11/Apicasso/CrudController).
This should be fixed for a better documentation.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Piste de recherche
Commencez par examiner les commentaires rendus dans les Ability docs et CRUD Controller endpoints liés, puis localisez leurs commentaires sources dans le dépôt. Comparez les exemples générés aux conventions de RDoc et vérifiez que les exemples sont correctement formatés et placés dans la documentation résultante.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- ruby
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100