Opened 3 months ago
Last modified 6 weeks ago
#59255 accepted defect (bug)
WP: Improve various globals documentation, as per docblock standards.
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 6.5 | Priority: | normal |
Severity: | normal | Version: | |
Component: | General | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description
I have reviewed the WordPress code and found some of the files need to be improved with function commenting code. Please check the below files list.
Files:
- wp-admin/includes/plugin.php
- wp-includes/rss.php
- wp-includes/widgets.php
Attachments (5)
Change History (19)
#1
@
3 months ago
- Keywords has-patch changes-requested added
Thanks for the patch @upadalavipul.
However, the global in wp-admin/includes/plugin.php
should be placed with the other globals listed in that global.
#2
@
3 months ago
And we should use a description for $wp_version for consistency with other doblocks:
* @global string $wp_version The WordPress version string.
#3
@
3 months ago
Same goes for $wp_registered_widgets
:
* @global array $wp_registered_widgets The registered widgets.
#6
@
3 months ago
@audrasjb I have Updated Patch as per Mentioned Changes
For wp-admin/includes/plugin.php : Its already placed with other global listed in trunk.
Ref: https://prnt.sc/ubQvBzQjsUNG (In Trunk Version)
#7
@
3 months ago
I have Updated Patch.
Changed Description for $wp_registered_widgets in /wp-includes/widgets.php
- Used
* @global array $wp_registered_widgets The registered widgets.
for$wp_registered_widgets
- Used
* @global array $wp_registered_sidebars The registered sidebars.
for$wp_registered_sidebars
#8
@
2 months ago
@audrasjb would you be able to review these updated patches to determine whether this ticket is ready for the next step?
This ticket was mentioned in Slack in #core-docs by nicolefurlan. View the logs.
7 weeks ago
#11
@
7 weeks ago
I've dropped this ticket into #core-docs to hopefully get some eyes on these copy changes.
This ticket was mentioned in Slack in #core by oglekler. View the logs.
6 weeks ago
#13
@
6 weeks ago
- Keywords needs-copy-review removed
This ticket was discussed in today's bug scrub. Since they're code docs, they don't need copy review, they need code review.
@hellofromTonya will take a look at this!
patch added