Make WordPress Core

Opened 5 weeks ago

Last modified 6 days ago

#63166 new task (blessed)

Docblock improvements for WP 6.9

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

Description

Previously:

Change History (6)

#1 @audrasjb
4 weeks ago

In 60109:

Docs: Remove an unwanted trailing space found after [60108].

Follow-up to [60108].

See #63041, #63166.

#2 @SergeyBiryukov
4 weeks ago

In 60112:

Docs: Merge file-level and class-level DocBlocks in wp_get_canonical_url() test file.

Per the documentation standards, whenever possible, all WordPress files should contain a header DocBlock, regardless of the file’s contents – this includes files containing classes.

However, this recommendation makes less sense for unit test classes if not applied consistently, and the duplicate tags cause some confusion.

This commit aims to reduce confusion and avoid repeating information by combining the DocBlocks.

Includes using third-person singular verbs in test method descriptions, as per the documentation standards.

Follow-up to [55337], [60108], [60109].

See #63166.

#3 @audrasjb
4 weeks ago

In 60120:

Docs: Update inline docs for various general template functions.

Props dilipbheda, mukesh27.
Fixes #63215.
See #63166.

#4 @SergeyBiryukov
4 weeks ago

In 60121:

Docs: Correct the type of the $name parameter in get_template_part action.

The value cannot be null at this point, as it is converted to a string a few lines above.

Follow-up to [45059], [55870], [60120].

See #63215, #63166.

#5 @jorbin
3 weeks ago

In 60139:

Docs: Update inline docs for various general template functions.

Reviewed By peterwilsoncc, jorbin.
Merges [60120] and [60121] to the 6.8 branch.

Props dilipbheda, mukesh27, SergeyBiryukov, audrasjb.
Fixes #63215.
See #63166.

#6 @johnbillion
6 days ago

In 60178:

Docs: Improve and standardise the format of placeholder strings that get replaced within email messages.

This prevents the strings being treated as h3 headings by the documentation parser on developer.wordpress.org.

See #63166

Note: See TracTickets for help on using tickets.