WordPress.org

Make WordPress Core

Opened 7 weeks ago

Last modified 20 hours ago

#53399 new task (blessed)

Docblock improvements for WP 5.9

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

Description

Previously:

Change History (20)

#1 @SergeyBiryukov
4 weeks ago

In 51278:

Docs: Document the globals used in some REST API methods.

See #53399.

#2 @johnbillion
4 weeks ago

In 51297:

Docs: Fix the documentation for the $tests parameter of the site_status_tests filter.

Tests are contained within direct and async properties of this array, not directly in the array itself. This also clarifies the properties that differ between direct and async tests.

See #53399, #46573

#3 @johnbillion
4 weeks ago

In 51298:

Docs: Corrections and improvements to types used in docblocks for symbols, properties, and filters.

See #53399

#4 @johnbillion
4 weeks ago

In 51299:

Docs: Miscellaneous formatting corrections for docblocks.

See #53399

#5 @johnbillion
4 weeks ago

In 51300:

Docs: Descriptive improvements and corrections for various docblocks.

See #53399

#6 @SergeyBiryukov
4 weeks ago

Looks like [51300] accidentally reverted [51299].

#7 @johnbillion
4 weeks ago

In 51301:

Docs: Undo the accidental revert of [51299] made in [51300].

See #53399

#8 @johnbillion
4 weeks ago

In 51302:

Docs: Further type corrections and improvements for various docblocks.

See #53399

#9 @SergeyBiryukov
4 weeks ago

In 51303:

Docs: Correct description for the $image parameter of the wp_save_image_file filter.

Follow-up to [27357], [48798], [51302].

See #53399.

#10 @SergeyBiryukov
4 weeks ago

In 51328:

Docs: Add @since tags for WP_Theme class properties.

Document WordPress versions Twenty Twelve and later bundled themes were introduced in.

See #53399.

#11 @johnbillion
4 weeks ago

In 51330:

Docs: Miscellaneous docblock improvements.

See #53399

#12 @SergeyBiryukov
3 weeks ago

In 51425:

Docs: Correct documentation for wp_get_post_parent_id().

The $post parameter is required and does not have a default value.

Follow-up to [42397].

Props denisco.
See #53399.

#13 @SergeyBiryukov
2 weeks ago

In 51430:

Docs: Synchronize the $post_id argument description for some post and attachment functions.

See #53399.

#14 @johnbillion
9 days ago

In 51477:

Docs: Miscellaneous docblock corrections and improvements.

See #53399

#15 follow-up: @SergeyBiryukov
9 days ago

@johnbillion Removing @global tags for $wp_local_package and $wp_locale in setup_config_display_header() doesn't seem correct, they are both used further in the function.

Should we perhaps declare them explicitly instead of accessing via the $GLOBALS array?

#16 in reply to: ↑ 15 ; follow-up: @johnbillion
9 days ago

Replying to SergeyBiryukov:

they are both used further in the function

They actually fall outside of the function, which ends a few lines above. I didn't check but I suspect that's the original intention of those docs.

#17 in reply to: ↑ 16 @SergeyBiryukov
9 days ago

Replying to johnbillion:

They actually fall outside of the function, which ends a few lines above.

Ah, yes, you're right. The docs were added in [32642], apparently due to a similar mistake that I made.

#18 @SergeyBiryukov
4 days ago

In 51495:

Docs: Clarify the @return value for WP_Filesystem_Base::getnumchmodfromh().

Follow-up to [9117], [51494].

See #53399.

#19 @johnbillion
21 hours ago

In 51513:

Docs: Correct the documented allowed range for the minute and second parameters of WP_Query.

These are correctly documented and validated in WP_Date_Query as 0-59.

See #53399

#20 @johnbillion
20 hours ago

In 51514:

Docs: Add missing documentation for the minute parameter of WP_Query.

See #53399

Note: See TracTickets for help on using tickets.