phpDocumentor / phpDocumentor/ReflectionDocBlock

Add more information when an InvalidTag occurs and a link to the phpDocumentor documentation

オープン
#346 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
PHP
スター
9.4k
フォーク
137
平均マージ
4日 2時間
マージ済み PR(30日)
1

説明

In issue https://github.com/phpDocumentor/phpDocumentor/issues/3378, there was some confusion because the Author tag does not support a description. When the StandardTagFactory encounters a situation where an InvalidTag is generated, it would be nice if it could ask the Tag class what the expected format is and a link to the documentation; and include that in the InvalidTag so that phpDocumentor can provide better error messages in the error report

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

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

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず StandardTagFactory、InvalidTag、および issue に記載されている Tag クラスの動作を読み、次に issue 3378 の関連する議論を確認してください。InvalidTag インスタンスに期待されるタグ形式と、関連する phpDocumentor ドキュメントへのリンクが含まれ、エラーレポートでより明確な指針を示せるようになれば完了です。

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

評価

技術スタック
php
領域
documentation
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

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

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