WordPress.org

Make WordPress Core

Opened 4 months ago

Closed 4 months ago

Last modified 4 months ago

#53461 closed defect (bug) (fixed)

Final docblock fixes for 5.8

Reported by: johnbillion Owned by: desrosj
Milestone: 5.8 Priority: normal
Severity: normal Version: 5.8
Component: General Keywords:
Focuses: docs Cc:

Description

Some docblock corrections for code introduced in 5.8 that we should squeeze in so the developer.wordpress.org docs are as correct as can be.

Change History (48)

This ticket was mentioned in PR #1398 on WordPress/wordpress-develop by johnbillion.


4 months ago

  • Keywords has-patch added

#2 @johnbillion
4 months ago

  • Keywords dev-feedback added

#3 @desrosj
4 months ago

  • Owner set to desrosj
  • Status changed from new to reviewing

#4 @desrosj
4 months ago

In 51221:

Docs: Various docblock corrections for code added in 5.8.

Props johnbillion.
See #53461.

#5 @desrosj
4 months ago

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

In 51222:

Docs: Remove inaccurate @since tag.

Follow up to [50829,50831,51145,51147].

Props johnbillion.
Fixes #53461. See #50105.

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


4 months ago

#8 @SergeyBiryukov
4 months ago

In 51249:

Docs: Update documentation for WP_Widget_Block per the documentation standards.

Remove unused $post global reference.

Follow-up to [50995], [51058], [51063], [51221].

See #52628, #53461.

#9 @SergeyBiryukov
4 months ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Reopening this for some more fixes.

#10 @SergeyBiryukov
4 months ago

In 51279:

Docs: Document the globals used in WP_REST_Widget_Types_Controller and WP_REST_Widgets_Controller.

Follow-up to [50995].

See #52628, #53461.

#11 @SergeyBiryukov
4 months ago

In 51280:

Docs: Add missing @since tags for some REST API methods added in 5.8.

Follow-up to [50995], [51021].

See #52628, #53461.

#12 @SergeyBiryukov
4 months ago

In 51281:

Docs: Add @ticket references to some WP_Theme_JSON tests.

Follow-up to [50973], [51054].

See #52628, #53461.

#13 @SergeyBiryukov
4 months ago

In 51282:

Docs: Adjust wp_dashboard_browser_nag() DocBlock per the documentation standards.

Follow-up to [51117], [51119], [51120].

See #52628, #53461.

#14 @SergeyBiryukov
4 months ago

In 51283:

Docs: Add missing @since tags for some WP_Theme_JSON methods.

Docs: Update syntax for multi-line comments per the documentation standards.

Follow-up to [50959], [50967], [50973], [51051], [51089], [51149].

See #52628, #53461.

#15 @SergeyBiryukov
4 months ago

In 51284:

Docs: Improve documentation for optional parameters in WP_Theme_JSON_Resolver methods per the documentation standards.

Move add_action() call to wp-includes/default-filters.php.

Follow-up to [50959], [51221].

See #52628, #53461.

#16 @SergeyBiryukov
4 months ago

  • Keywords fixed-major added

[51279-51284,51286,51289,51292,51294,51304] can be merged to the 5.8 branch.

Last edited 4 months ago by SergeyBiryukov (previous) (diff)

#17 @SergeyBiryukov
4 months ago

In 51286:

Docs: List the expected type first instead of WP_Error in some REST API methods added in 5.8.

Follow-up to [46696], [49929], [50995], [51021].

See #52628, #53461.

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


4 months ago

#19 @SergeyBiryukov
4 months ago

In 51289:

Docs: Remove an empty line between @param and @return tags in some newly added REST API methods, per the documentation standards.

Follow-up to [48242], [49925], [51003], [51021].

See #52628, #53461.

#20 @SergeyBiryukov
4 months ago

In 51292:

Docs: Improve documentation for optional parameters in WP_Theme_JSON methods per the documentation standards.

Additionally:

  • Remove an empty line between @param and @return tags.
  • Correct alignment of @param tags.

Follow-up to [50959], [50973], [51149], [51284], [51289].

See #52628, #53461.

#21 @SergeyBiryukov
4 months ago

In 51294:

Twenty Twenty-One: Improve documentation per the documentation standards:

  • Remove unnecessary @access tags that were previously removed from core.
  • Remove an empty line between @param and @return tags.
  • Correct alignment of @param tags.

Follow-up to [41161], [41162], [41168], [49216], [49220].

See #52628, #53461.

#22 @SergeyBiryukov
4 months ago

In 51304:

Twenty Twenty-One: Add missing documentation for some filters.

Add missing @since tags for some functions.

Follow-up to [49216], [49220], [49854], [51294].

See #52628, #53461.

#23 @desrosj
4 months ago

In 51310:

Docs: Document the globals used in WP_REST_Widget_Types_Controller and WP_REST_Widgets_Controller.

Follow-up to [50995].

Props SergeyBiryukov.
Merges [51279] to the 5.8 branch.
See #52628, #53461.

#24 @desrosj
4 months ago

In 51311:

Docs: Add missing @since tags for some REST API methods added in 5.8.

Follow-up to [50995], [51021].

Props SergeyBiryukov.
Merges [51280] to the 5.8 branch.
See #52628, #53461.

#25 @desrosj
4 months ago

In 51312:

Docs: Add @ticket references to some WP_Theme_JSON tests.

Follow-up to [50973], [51054].

Props SergeyBiryukov.
Merges [51280] to the 5.8 branch.
See #52628, #53461.

#26 @desrosj
4 months ago

In 51313:

Docs: Adjust wp_dashboard_browser_nag() DocBlock per the documentation standards.

Follow-up to [51117], [51119], [51120].

Props SergeyBiryukov.
Merges [51282] to the 5.8 branch.
See #52628, #53461.

#27 @desrosj
4 months ago

In 51314:

Docs: Add missing @since tags for some WP_Theme_JSON methods.

Docs: Update syntax for multi-line comments per the documentation standards.

Follow-up to [50959], [50967], [50973], [51051], [51089], [51149].

Props SergeyBiryukov.
Merges [51283] to the 5.8 branch.
See #52628, #53461.

#28 @desrosj
4 months ago

In 51315:

Docs: Improve documentation for optional parameters in WP_Theme_JSON_Resolver methods per the documentation standards.

Move add_action() call to wp-includes/default-filters.php.

Follow-up to [50959], [51221].

Props SergeyBiryukov.
Merges [51284] to the 5.8 branch.
See #52628, #53461.

#29 @desrosj
4 months ago

In 51316:

Docs: List the expected type first instead of WP_Error in some REST API methods added in 5.8.

Follow-up to [46696], [49929], [50995], [51021].

Props SergeyBiryukov.
Merges [51286] to the 5.8 branch.
See #52628, #53461.

#30 @desrosj
4 months ago

In 51317:

Docs: Remove an empty line between @param and @return tags in some newly added REST API methods, per the documentation standards.

Follow-up to [48242], [49925], [51003], [51021].

Props SergeyBiryukov.
Merges [51289] to the 5.8 branch.
See #52628, #53461.

#31 @desrosj
4 months ago

In 51318:

Docs: Improve documentation for optional parameters in WP_Theme_JSON methods per the documentation standards.

Additionally:

  • Remove an empty line between @param and @return tags.
  • Correct alignment of @param tags.

Follow-up to [50959], [50973], [51149], [51284], [51289].

Props SergeyBiryukov.
Merges [51292] to the 5.8 branch.
See #52628, #53461.

#32 @desrosj
4 months ago

In 51319:

Twenty Twenty-One: Improve documentation per the documentation standards:

  • Remove unnecessary @access tags that were previously removed from core.
  • Remove an empty line between @param and @return tags.
  • Correct alignment of @param tags.

Follow-up to [41161], [41162], [41168], [49216], [49220].

Props SergeyBiryukov.
Merges [51294] to the 5.8 branch.
See #52628, #53461.

#33 @desrosj
4 months ago

In 51320:

Twenty Twenty-One: Add missing documentation for some filters.

Add missing @since tags for some functions.

Follow-up to [49216], [49220], [49854], [51294].

Props SergeyBiryukov.
Merges [51304] to the 5.8 branch.
See #52628, #53461.

#34 @desrosj
4 months ago

  • Keywords dev-reviewed commit added; dev-feedback fixed-major removed
  • Resolution set to fixed
  • Status changed from reopened to closed

All changes have been backported. If more are needed, we can reopen to backport those.

#35 @SergeyBiryukov
4 months ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

#36 @SergeyBiryukov
4 months ago

In 51322:

Twenty Twenty: Add missing documentation for some filters.

Add missing @since tags for some functions.

Correct alignment of some @param tags.

Follow-up to [46271], [46278], [51304].

See #52628, #53461.

#37 @SergeyBiryukov
4 months ago

In 51323:

Bundled Themes: Correct @since tags for block patterns.

Follow-up to [49347], [49348], [49583], [49584], [49763], [51103].

See #52628, #53461.

#38 @SergeyBiryukov
4 months ago

In 51324:

Docs: Correct @see references for hooks in the get_option() description.

Follow-up to [51050].

See #52628, #53461.

#39 @desrosj
4 months ago

In 51338:

Twenty Twenty: Add missing documentation for some filters.

Add missing @since tags for some functions.

Correct alignment of some @param tags.

Follow-up to [46271], [46278], [51304].

Props SergeyBiryukov.
Merges [51322] to the 5.8 branch.
See #52628, #53461.

#40 @desrosj
4 months ago

In 51339:

Bundled Themes: Correct @since tags for block patterns.

Follow-up to [49347], [49348], [49583], [49584], [49763], [51103].

Props SergeyBiryukov.
Merges [51324] to the 5.8 branch.
See #52628, #53461.

#41 @desrosj
4 months ago

In 51340:

Docs: Correct @see references for hooks in the get_option() description.

Follow-up to [51050].

Props SergeyBiryukov.
Merges [51324] to the 5.8 branch.
See #52628, #53461.

#42 @desrosj
4 months ago

  • Keywords commit removed
  • Resolution set to fixed
  • Status changed from reopened to closed

Everything has been backported, so closing out prior to RC2.

#43 @johnbillion
4 months ago

  • Keywords has-patch dev-reviewed removed
  • Resolution fixed deleted
  • Status changed from closed to reopened

One more.

#44 @johnbillion
4 months ago

In 51353:

Docs: Correct the @since tag for the user_erasure_fulfillment_email_headers filter.

See #44314, #53461

#45 @desrosj
4 months ago

  • Keywords commit dev-reviewed added

#46 @desrosj
4 months ago

In 51354:

Docs: Correct the @since tag for the user_erasure_fulfillment_email_headers filter.

Props johnbillion.
See #44314, #53461.

#47 @desrosj
4 months ago

  • Keywords commit dev-reviewed removed
  • Resolution set to fixed
  • Status changed from reopened to closed

#48 @desrosj
4 months ago

  • Component changed from Plugins to General
Note: See TracTickets for help on using tickets.