Opened 13 months ago
Closed 12 months ago
#63692 closed defect (bug) (fixed)
Bundled Theme: Add missing PHPDoc Block for the action.
| Reported by: | viralsampat | Owned by: | SergeyBiryukov |
|---|---|---|---|
| Priority: | normal | Milestone: | 6.9 |
| Component: | Bundled Theme | Version: | |
| Severity: | minor | Keywords: | has-patch changes-requested |
| Cc: | Focuses: | docs |
Description
Hello Team,
I reviewed the theme files and noticed the use of a PHPDoc block for the twentynineteen_scripts & twentyseventeen_scripts action hook in the Twenty Nineteen & Twenty Seventeen themes.
I think that it should be appropriate, as it helps with documentation and clarity.
Thanks,
Attachments (1)
Change History (34)
#1
@
13 months ago
- Keywords changes-requested added; needs-testing removed
- Severity normal → minor
- Version → trunk
There is a difference between the function comment. Enqueues vs Enqueue: should make it consistent.
This ticket was mentioned in PR #9294 on WordPress/wordpress-develop by @vladimiraus.
13 months ago
#2
Theme consistency in php doc.
#4
@
13 months ago
- Keywords dev-feedback 2nd-opinion reporter-feedback removed
- Milestone Awaiting Review → 6.9
- Version trunk
Thanks for the PR!
It looks good to me.
Move to 6.9
#5
@
13 months ago
- Summary Twenty Nineteen & Twenty Seventeen: Add PHPDoc Block for the twentynineteen_scripts & twentyseventeen_scripts action. → Bundled Theme: Add missing PHPDoc Block for the action.
#8
follow-up:
↓ 9
@
13 months ago
@SergeyBiryukov could you please commit changes for src/wp-content/themes/twentyfifteen/functions.php. The PR https://github.com/WordPress/wordpress-develop/pull/9294 have that changes.
#9
in reply to: ↑ 8
@
13 months ago
Replying to mukesh27:
could you please commit changes for
src/wp-content/themes/twentyfifteen/functions.php
I left that out for now, as those older themes are not super consistent with using third-person singular verbs in function descriptions, and there are at least 8 other instances of "Enqueue scripts" in other themes. So I think fixing just that one instance would not really add any consistency, see also twentyfifteen_block_editor_styles() for example.
Happy to reopen if someone is interested in updating all of those DocBlocks to use third-person singular verbs :)
This ticket was mentioned in PR #9305 on WordPress/wordpress-develop by @vladimiraus.
13 months ago
#11
Third-person singular verbs update for themes.
![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png)
I have reviewed above mentioned issue and resolved it. Here, I have added its patch.