DocBlock for hooks not parsed correctly in some cases
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- php
- Domain
- documentation
Research direction
Start by reproducing the issue with the two PHP snippets in the issue and trace how hook DocBlocks are parsed. Done means the inline @since 1.2.3 tag is associated with the imported hook, while @since tags from the file-level DocBlock are not.
Written by the indexing model from the issue text.
Description
While parsing the source for a plugin, I came across a case where the DocBlock for a hook isn't parsed correctly.
The code contains the following:
/**
* Filters the filename to be required.
*
* @since 1.2.3
*
* @param string $filename The filename to require.
*/
require apply_filters( 'my-filter', 'some filename' );
The hook gets imported (including the description), but for some reason the @since tag is not. Instead, @since tags from the file-level DocBlock are associated with the hook.
Changing the code to the equivalent:
/**
* Filters the filename to be required.
*
* @since 1.2.3
*
* @param string $filename The filename to require.
*/
$filename = apply_filters( 'my-filter', 'some filename' );
require $filename;
works just fine.
- 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
-
Bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Automattic/safe-publish#594 ·
-
HttpClient
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
symfony/symfony-docs#23092 ·
-
sync-en
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
sync-en
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Перевод устарел
Difficulty 2/5 1-3 hours Newbie friendliness 75/100