Make WordPress Core

Opened 10 months ago

Closed 5 months ago

#59255 closed defect (bug) (fixed)

WP: Improve various globals documentation, as per docblock standards.

Reported by: upadalavipul's profile upadalavipul Owned by: audrasjb's profile audrasjb
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:

  1. wp-admin/includes/plugin.php
  2. wp-includes/rss.php
  3. wp-includes/widgets.php

Attachments (5)

59255.patch (1.3 KB) - added by upadalavipul 10 months ago.
patch added
59255.2.patch (1.0 KB) - added by shailu25 10 months ago.
Updated Patch
59255.3.patch (2.7 KB) - added by viralsampat 10 months ago.
59255.4.patch (7.2 KB) - added by shailu25 10 months ago.
Updated Patch
59255.5.patch (1.1 KB) - added by viralsampat 7 months ago.
I have checked above mentioned issue and founds few files. Here, I have added its patch.

Download all attachments as: .zip

Change History (21)

@upadalavipul
10 months ago

patch added

#1 @audrasjb
10 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 @audrasjb
10 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 @audrasjb
10 months ago

Same goes for $wp_registered_widgets:
* @global array $wp_registered_widgets The registered widgets.

#4 @audrasjb
10 months ago

  • Owner set to audrasjb
  • Status changed from new to accepted

#5 @audrasjb
10 months ago

  • Milestone changed from Awaiting Review to 6.4

@shailu25
10 months ago

Updated Patch

#6 @shailu25
10 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)

Last edited 10 months ago by shailu25 (previous) (diff)

@shailu25
10 months ago

Updated Patch

#7 @shailu25
10 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 @nicolefurlan
9 months ago

@audrasjb would you be able to review these updated patches to determine whether this ticket is ready for the next step?

#9 @oglekler
9 months ago

  • Keywords needs-copy-review added; changes-requested removed

This ticket was mentioned in Slack in #core-docs by nicolefurlan. View the logs.


9 months ago

#11 @nicolefurlan
9 months ago

I've dropped this ticket into #code-docs to hopefully get some eyes on these copy changes.

Version 0, edited 9 months ago by nicolefurlan (next)

This ticket was mentioned in Slack in #core by oglekler. View the logs.


8 months ago

#13 @nicolefurlan
8 months 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!

Last edited 8 months ago by nicolefurlan (previous) (diff)

#14 @hellofromTonya
8 months ago

  • Milestone changed from 6.4 to 6.5

The RC1 release party is about to start. Moving this to 6.5.

@viralsampat
7 months ago

I have checked above mentioned issue and founds few files. Here, I have added its patch.

#15 @audrasjb
5 months ago

@viralsampat getid3.lib.php is in an external library and should be fixed upstream and duotone.php comes from Gutenberg and should also be fixed upstream. I'm going to commit patch 59255.4.patch.

#16 @audrasjb
5 months ago

  • Resolution set to fixed
  • Status changed from accepted to closed

In 57370:

Docs: Improve various globals documentation, as per docblock standards.

Props upadalavipul, audrasjb, shailu25, viralsampat.
Fixes #59255.
See #59651.

Note: See TracTickets for help on using tickets.