Add support for parsing docs for single constants
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 25/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- php
- 領域
- documentation, tooling
調査の方向性
PR #203 と、parser に既に存在する定数処理の経路から始めてください。PR がどのように定数を post type に組み込み、そのドキュメントを取得するのかを確認してください。完了の条件は説明が保存されることであり、post type の編集と表示サポートは対象外です。phpDocumentor はまだ DocBlock templates をサポートしていないことに注意してください。
索引モデルが issue の本文から書いたものです。
説明
The parser already technically supports parsing constants, but the attached PR hooks them up to a new post type and retrieves the associated documentation. We can add post type / editing / display support at a later time in the wporg-developer theme, but it would be nice to be actually storing the descriptions somewhere.
PR: #203
It should be noted that parsing DocBlock template support is not yet available in phpDocumentor, which means core WordPress is kind of out of luck with the current state of constants documented in wp-config.php. Templates are the ability to document multiple elements at the same time, e.g.
/**#@+
* DocBlock Template example: One summary for all.
*
* One description for all.
*
* @since 2.6.0
*/
define('AUTH_KEY', '...');
define('SECURE_AUTH_KEY', '...');
define('LOGGED_IN_KEY', '...');
define('NONCE_KEY', '...');
define('AUTH_SALT', '...');
define('SECURE_AUTH_SALT', '...');
define('LOGGED_IN_SALT', '...');
define('NONCE_SALT', '...');
/**#@-*/
- 主要言語
- PHP
- スター
- 239
- フォーク
- 81
- 平均マージ
- 16時間 29分
- マージ済み PR（30日）
- 8
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
WordPress/phpdoc-parser のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
WordPress/phpdoc-parser#269 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 64/100
WordPress/phpdoc-parser#268 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
WordPress/phpdoc-parser#254 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
WordPress/phpdoc-parser#246 · コメント 9 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
WordPress/phpdoc-parser#235 · コメント 1 件 ·
WordPress/phpdoc-parser の issue をすべて見る
似ている issue
-
tooling
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
UX
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
ProfessionalWiki/NeoWiki#1525 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
bug customer-reported
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
MagnaCapax/PMSS#949 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
Automattic/static-site-importer#1829 ·