![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png){kind=logo}
Opened 9 years ago
Closed 9 years ago
#3134 closed enhancement (fixed)
WordPress.tv: Add @param and @global keywords for some variables
| Reported by: | rushabh4486 | Owned by: | obenland |
|---|---|---|---|
| Priority: | lowest | Milestone: | |
| Component: | WordPress.tv | Keywords: | has-patch needs-refresh |
| Cc: |
Description
Documents need to improve.
Attachments (2)
Change History (26)
#2
@
9 years ago
- Summary Missing to define @param and @global some variable in wordpress.tv's theme wptv2. → WordPress.tv: Add @param and @global keywords for some variables
This ticket was mentioned in Slack in #meta by rushabhshah. View the logs.
9 years ago
This ticket was mentioned in Slack in #wptv by rushabhshah. View the logs.
9 years ago
#9
in reply to: ↑ 8
;
follow-up:
↓ 11
@
9 years ago
Replying to SergeyBiryukov:
Hi @rushabh4486, welcome to WordPress Meta Trac! Thanks for the patch.
Per WordPress' PHP Documentation Standards,
@globaltags are used to document globals in functions or methods. What's the benefit of adding@globaltags right next to the global declarations in theme templates? Seems redundant, and none of the bundled themes do that.
What about @param tag?
@SergeyBiryukov
#11
in reply to: ↑ 9
@
9 years ago
Replying to rushabh4486:
What about @param tag?
The change in functions.php looks good, though it would also be helpful to add a description, something like:
@param WP_Query $query Current query object.
This ticket was mentioned in Slack in #wptv by rushabhshah. View the logs.
9 years ago
#16
@
9 years ago
- Priority highest omg bbq → lowest
Hi @rushabh4486, thanks for your contribution here. Conforming to PHPDoc is a good thing to do. Compared to other tickets, though, this is a very low priority.
That doesn't mean that it won't be accepted one day, but properly prioritizing tickets helps us focus our time on what will make the biggest impact.
#18
@
9 years ago
- Priority high → lowest
Hi @rushabh4486, this should remain at lowest, per comment:16. Thanks :)
This ticket was mentioned in Slack in #wptv by rushabhshah. View the logs.
9 years ago
#23
@
9 years ago
- Keywords dev-feedback removed
- Priority highest omg bbq → lowest
- Type defect → enhancement
Hi @rushabh4486, this should remain at lowest because this is just documentation. And I guess it's better as a enhancement because the same reason.
You can check more information about Ticket Properties here. :)
Hi @rushabh4486, welcome to WordPress Meta Trac! Thanks for the patch.
Per WordPress' PHP Documentation Standards,
@globaltags are used to document globals in functions or methods. What's the benefit of adding@globaltags right next to the global declarations in theme templates? Seems redundant, and none of the bundled themes do that.