autoforce / autoforce/APIcasso
Adapt comments into RDoc convention
- Lenguaje dominante
- Ruby
- Estrellas
- 31
- Forks
- 1
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
Empieza revisando los comentarios renderizados en los Ability docs y CRUD Controller endpoints enlazados, y después localiza sus comentarios fuente en el repositorio. Compara los ejemplos generados con las convenciones de RDoc y verifica que los ejemplos estén correctamente formateados y ubicados en la documentación resultante.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- ruby
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100