cakephp / cakephp/cakephp-api-docs
cake 5: Support parameters with only type hints
オープン
まだ誰も着手していません。
- 主要言語
- PHP
- スター
- 29
- フォーク
- 15
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Starting with cake 5, some function parameters won't have matching docblock @param annotations.
Do we want to still list these parameters in the parameter block with no description or should we hide them?

These parameters won't have a matching annotation because PHP 8 allows union types that fully documents the allowed types and the parameter name is self-documenting (the annotation description isn't helpful).
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、PHP 8 の型ヒントを持つ CakePHP 5 のパラメーターが API ドキュメントでどのように表現されているかを確認します。対応する @param アノテーションがないパラメーターを空の説明付きで表示するのか、非表示にするのかを判断し、選択した動作のテストカバレッジを追加します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- php
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100