Add support for parsing docs for single constants
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- php
- Domain
- documentation, tooling
Research direction
Start with PR #203 and the parser's existing constant-handling path. Check how the PR hooks constants into a post type and retrieves their documentation; done means descriptions are stored, while post type editing and display support remain out of scope. Note that phpDocumentor does not yet support DocBlock templates.
Written by the indexing model from the issue text.
Description
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', '...');
/**#@-*/
- Dominant language
- PHP
- Stars
- 239
- Forks
- 81
- Avg merge
- 16h 29m
- Merged PRs (30d)
- 8
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from WordPress/phpdoc-parser
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
WordPress/phpdoc-parser#269 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 64/100
WordPress/phpdoc-parser#268 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
WordPress/phpdoc-parser#254 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
WordPress/phpdoc-parser#246 · 9 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
WordPress/phpdoc-parser#235 · 1 comment ·
All issues in WordPress/phpdoc-parser
Similar issues
-
tooling
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
UX
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
ProfessionalWiki/NeoWiki#1525 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
OpenConext/OpenConext-engineblock#2122 ·
-
Bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Automattic/safe-publish#594 ·