Make WordPress Core

Opened 6 weeks ago

Last modified 3 weeks ago

#62281 new task (blessed)

Docblock improvements for WP 6.8

Reported by: desrosj's profile desrosj Owned by:
Milestone: 6.8 Priority: normal
Severity: normal Version:
Component: General Keywords:
Focuses: coding-standards Cc:

Description

Previously:

Change History (5)

#1 @SergeyBiryukov
6 weeks ago

In 59291:

Docs: Adjust comments about set_time_limit() per the documentation standards.

Includes splitting long comments into multiple lines and moving a few comments above the function_exists() check for more consistent placement.

Follow-up to [59039], [59288].

See #62281.

#2 @SergeyBiryukov
5 weeks ago

In 59333:

Docs: Correct @param tag in untrailingslashit() to match the parameter name.

Follow-up to [54927].

Props justlevine.
See #52217, #62281.

#3 @SergeyBiryukov
5 weeks ago

In 59334:

Docs: Correct @param type in fix_phpmailer_messageid().

Follow-up to [48033].

Props justlevine.
See #52217, #62281.

#4 @SergeyBiryukov
5 weeks ago

In 59336:

Docs: Add missing void to DocBlock @return types.

This commit adds missing void return types to (parent) methods that can explicitly return void as one of their conditional paths.

Addressed methods:

  • WP_Privacy_Requests_Table::column_status()
  • WP_Recovery_Mode::handle_error()
  • WP_Widget::form() — unlike the others, it's the child classes that return void when the method is correctly implemented.

Note: @return void (where void is the single type returned) should not be used outside the default bundled themes and the PHP compatibility shims included in WordPress Core, as per the documentation standards.

Follow-up to [30382], [42967], [43256], [44973], [45448].

Props justlevine.
See #52217, #62281.

#5 @johnbillion
3 weeks ago

In 59405:

Docs: Correct the spelling of silicon in the local development environment readme.

See #62281

Note: See TracTickets for help on using tickets.