WordPress / WordPress/phpdoc-parser
Wrong docblock for hooks with multiple usages
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 239
- Forks
- 81
- Avg merge
- 16h 29m
- Merged PRs (30d)
- 8
Description
When a hook is used multiple times, the wrong docblock will get associated with it if the usage with just the This hook is documented in file.php type docblock is parsed after the canonical one. Examples:
Related: #43, #94
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.
Research direction
Reproduce the parsing behavior using the listed hooks: user_new_form_tag, rss_update_period, and admin_xml_ns, comparing canonical docblocks with the “This hook is documented in file.php” form. Trace how multiple usages are associated and verify that parsing order no longer replaces the canonical docblock with the reference-only one.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100