WordPress.org

Make WordPress Core

Opened 5 weeks ago

Last modified 5 days ago

#49572 new task (blessed)

Docblock improvements for 5.5

Reported by: SergeyBiryukov Owned by:
Milestone: 5.5 Priority: normal
Severity: normal Version:
Component: General Keywords:
Focuses: docs Cc:

Description

Previously:

Change History (6)

#1 @SergeyBiryukov
5 weeks ago

In 47428:

Docs: Reorder @throws tags in WP_Customize_Nav_Menu_Setting and WP_Customize_Nav_Menu_Item_Setting for consistency with WP_Customize_Custom_CSS_Setting.

See #49572.

#2 @johnbillion
3 weeks ago

In 47461:

Docs: Various docblock corrections and improvements.

See #49572

#3 @SergeyBiryukov
2 weeks ago

In 47498:

Docs: Update inline comment in Tests_DB::test_locale_floats().

See #49572.

#4 @SergeyBiryukov
2 weeks ago

Related: [47170], [47502].

As noted in comment:103:ticket:48303, the $value parameter of WP_Dependencies::add_data() has a mixed type, but is described as a string in several places:

  • "Extra item data (string)" in WP_Dependencies::get_data().
  • "String containing the data to be added" in wp_script_add_data().
  • "String containing the CSS data to be added" in wp_style_add_data().

Would be great to clean up this inconsistency one way or another.

#5 @SergeyBiryukov
5 days ago

In 47545:

Docs: Use third-person singular verbs for function descriptions in wp-includes/category-template.php, per the documentation standards.

See #49572.

#6 @SergeyBiryukov
5 days ago

Related: [47394]

Per comment:97:ticket:48303, image_downsize filter description could use a clarification about when the value can be an array (if another filter is filtering the value and returning an array intended as the short-circuited return value).

Note: See TracTickets for help on using tickets.