Make WordPress Core

Opened 2 months ago

Last modified 2 days ago

#52628 new task (blessed)

Docblock improvements for WP 5.8

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

Description (last modified by SergeyBiryukov)


Attachments (1)

52628.htmlhint.diff (1.0 KB) - added by sabernhardt 4 weeks ago.

Download all attachments as: .zip

Change History (18)

#1 @SergeyBiryukov
2 months ago

  • Description modified (diff)

#2 @SergeyBiryukov
2 months ago

In 50434:

Docs: Correct function name in add_settings_field() DocBlock.

See #52628.

#3 @SergeyBiryukov
8 weeks ago

In 50460:

Docs: Clarify a comment about wp_opcache_invalidate() in _copy_dir().

Follow-up to [48160].

See #52628.

#4 @SergeyBiryukov
7 weeks ago

In 50484:

Docs: Update documentation in some WP_REST_Request tests per the documentation standards.

Follow-up to [49329].

See #52628.

#5 @SergeyBiryukov
7 weeks ago

In 50491:

Docs: Update inline comments in some test files per the documentation standards.

See #52628.

#6 @johnbillion
7 weeks ago

In 50505:

Docs: Add examples of possible names for various hooks whose name contains a dynamic portion.

This provides greater discoverability of such hooks in search results on the Code Reference site as well as increased clarity when reading the source.

See #50734, #52628

#7 follow-up: @peterwilsoncc
6 weeks ago

In 50516:

Docs: Improve compatibility comment in WP_List_Table.

Improve comment explaining backward compatibility check for the primary column in WP_List_Table::get_column_info().

Unprops helen, markjaquith.
See #52628, #34564.

#8 in reply to: ↑ 7 @jeremyfelt
6 weeks ago

Replying to peterwilsoncc:

In 50516:

"added as a forth item" should be "added as a fourth item" :)

#9 @peterwilsoncc
6 weeks ago

In 50517:

Docs: Improve spelling in [50516].

Props jeremyfelt.
See #52628, #34564.

#10 @SergeyBiryukov
6 weeks ago

In 50531:

Docs: Correct DocBlock formatting for register_block_style_handle().

Follow-up to [48141].

See #52628.

#11 @SergeyBiryukov
6 weeks ago

In 50532:

Docs: Synchronize $category_name description in WP_Block_Pattern_Categories_Registry methods.

Follow-up to [48156].

See #52628.

#12 @SergeyBiryukov
5 weeks ago

In 50562:

Docs: Fix typo in pre_term_link filter description.

See #52628.

#14 @davidbaumwald
4 weeks ago

Thanks for the patch, @sabernhardt. I found another instance of $htmlhint being improperly described in another docblock on line 3537 in wp-includes/general-template.php. I'll address that one as well in the commit that follows.

#15 @davidbaumwald
4 weeks ago

In 50583:

Docs: Fix description for $htmlhint argument in code editor settings.

Introduced in [41558].

Props sabernhardt.
See #52628.

#16 @SergeyBiryukov
4 weeks ago

In 50610:

Docs: Spell "non-existent" in a consistent way.

See #52628.

#17 @SergeyBiryukov
2 days ago

In 50781:

Docs: Add a @since note to wp_mail() about using is_email() for validation.

Follow-up to [48645].

See #52628.

Note: See TracTickets for help on using tickets.