autoforce / autoforce/APIcasso

Adapt comments into RDoc convention

オープン
#29 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
documentation
主要言語
Ruby
スター
31
フォーク
1
PR マージ指標
30日以内にマージされた PR はありません

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

まず、リンクされた Ability docs と CRUD Controller endpoints にレンダリングされたコメントを確認し、その後、リポジトリ内でそれらのソースコメントを探します。生成された例を RDoc の規約と比較し、例が生成されたドキュメント内で正しくフォーマットされ、適切に配置されていることを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
ruby
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。