cakephp / cakephp/cakephp-api-docs
Web site API reference lacks extended class and implemented interfaces...
まだ誰も着手していません。
- 主要言語
- PHP
- スター
- 29
- フォーク
- 15
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Description
I feel strange because I can't believe I can't find it...
I pick up just an example. I was trying to understand what Cake\ORM\ResultSet actually is. Easy to guess by the scope and the name (and the methods). But, apart from that, commonly I am used to find reference to extended class and implemented interfaces in API reference documentations. For CakePHP I have to open the source code link.
Example: Cake\ORM\ResultSet.
CakePHP Version
5.2
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Issue にリンクされている Cake\ORM\ResultSet API リファレンスページから始め、リンクされているソースコードと比較します。API リファレンスがどのように生成されるかを追跡し、そのうえで、拡張されたクラスと実装されたインターフェースがページに表示されることを確認し、生成された出力を検証します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- php
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100