Make WordPress Core

Opened 5 months ago

Closed 3 weeks ago

#60699 closed task (blessed) (fixed)

Docblock improvements for 6.6

Reported by: sergeybiryukov's profile SergeyBiryukov Owned by:
Milestone: 6.6 Priority: normal
Severity: normal Version:
Component: General Keywords: has-patch
Focuses: docs, coding-standards Cc:

Description

Previously:

Change History (37)

#1 @SergeyBiryukov
5 months ago

  • Type changed from defect (bug) to task (blessed)

#2 @SergeyBiryukov
5 months ago

In 57785:

Docs: Add a description for the $wp_embed global.

Follow-up to [57748].

See #60699.

#3 @SergeyBiryukov
5 months ago

In 57787:

Docs: Add a description for the $table_prefix global.

Follow-up to [57748].

See #60699.

#4 @audrasjb
5 months ago

In 57793:

Docs: Update various HelpHub links to avoid unnecessary redirections.

This updates various WP-Admin related links that have been redirected to new HelpHub pages, to avoid unnecessary redirections.

Props mkismy.
See #60732, #60699.

#5 @audrasjb
5 months ago

In 57800:

Docs: Update various HelpHub links located in bundled themes to avoid unnecessary redirections.

Props mkismy.
See #60732, #60699.

#6 @audrasjb
5 months ago

In 57801:

Docs: Update various HelpHub links to avoid unnecessary redirections.

Follow-up to [57793], [57798], [57800].

Props mkismy.
See #60732, #60699.

#7 @audrasjb
4 months ago

In 57854:

Docs: Update various HelpHub links to avoid unnecessary redirections.

Follow-up to [57793], [57798], [57800], [57801].

Props shailu25.
See #60732, #60699.

#8 @audrasjb
4 months ago

In 57910:

Docs: Various typo corrections in wp-includes/formatting.php.

Props shailu25.
Fixes #60814.
See #60699.

#9 @swissspidy
4 months ago

In 57987:

Docs: Fix various typos and spelling mistakes.

Props swissspidy, jucaduca, sergeybiryukov.
See #60699.

#10 @swissspidy
4 months ago

In 57988:

Docs: Revert unintended svn:ignore change after [57987].

See #60699.

#11 @audrasjb
3 months ago

In 58032:

Docs: Typo corrections in class WP_Meta_Query.

Props truptikanzariya.
Fixes #61051.
See #60699.

#12 @swissspidy
3 months ago

In 58037:

Docs: Improve incorrect indentation/alignment in a few docblocks.

See #60699.

#13 @johnbillion
3 months ago

In 58071:

Docs: Correct some docblock indentation.

See #60699

#14 @johnbillion
3 months ago

In 58073:

Docs: Various docblock corrections.

See #60699

#15 @johnbillion
3 months ago

In 58075:

Docs: Various docblock improvements.

See #60699

#16 @johnbillion
3 months ago

In 58084:

Docs: Document the array shapes for parsed blocks, template part areas, and template types.

See #60699

#17 @johnbillion
3 months ago

In 58085:

Docs: Revert the documentation change to WP_Block_Parser::parse() made in [58084].

This file needs to be synced from the Gutenberg repository.

See #60699

#18 @SergeyBiryukov
3 months ago

In 58131:

Docs: Use more specific URLs for a few Network Admin HelpHub links.

This better reflects the originally intended destination of these links.

Follow-up to [57854].

See #60732, #60699.

#19 @SergeyBiryukov
3 months ago

In 58132:

Docs: Update a HelpHub link on Edit Site screen to avoid unnecessary redirection.

Follow-up to [17045], [20713], [41065], [45674], [55412], [57854], [58131].

Props shailu25.
See #60732, #60699.

#20 @swissspidy
2 months ago

In 58155:

Docs: Fix incorrect docblock for WP_Translation_Controller::translate_plural.

Props szepeviktor.
See #60699.

#21 @swissspidy
2 months ago

In 58156:

Docs: Improve docblock for WP_REST_Template_Revisions_Controller::get_parent().

Props rockfire.
See #60699, #61113.

#22 @SergeyBiryukov
2 months ago

In 58212:

Docs: Improve documentation for a few functions accepting a WP_Post object.

Follow-up to [15777], [23769], [24490], [25697], [37252], [49544].

See #60699.

#23 @SergeyBiryukov
2 months ago

In 58224:

Docs: Clarify that the $wp_error parameter of login_header() is nullable.

Follow-up to [7991], [25701], [28792], [43457], [58209], [58220].

See #60668, #60699.

#24 @swissspidy
8 weeks ago

In 58266:

Docs: Improve docblock for WP_Theme_JSON::get_stylesheet().

See #60699.

This ticket was mentioned in ��PR #6654 on WordPress/wordpress-develop by @Mat Lipe.


8 weeks ago
#25

  • Keywords has-patch added

The return type was int but it would return false if the date format passed is invalid.

#26 @SergeyBiryukov
8 weeks ago

In 58267:

Docs: Correct @return value for rest_parse_date().

Follow-up to [34928], [36086], [47450].

Props mat-lipe, mukesh27, freewebmentor.
See #60699.

@SergeyBiryukov commented on PR #6654:


8 weeks ago
#27

Thanks for the PR! Merged in r58267.

#28 @swissspidy
8 weeks ago

In 58268:

Docs: Improve docblock for block_template_part().

Clarify that $part is not limited to just 'header' or 'footer'.

See #60699.

#29 @audrasjb
8 weeks ago

In 58317:

Docs: Fix docblock alignment in class-wp-duotone.php.

Follow-up to [58313].

Props mukesh27.
See #61271, #60699.

#30 @audrasjb
7 weeks ago

In 58385:

Docs: Various docblock improvements in HTTP Request API, as per WP docs standards.

See #60699.

#31 @audrasjb
7 weeks ago

In 58390:

Docs: Fix improper docblock format in lang_dir_for_domain hook.

Follow-up to [58236].

Props khokansardar.
See #60699.

#33 @peterwilsoncc
6 weeks ago

In 58397:

Docs: Correct typos in JavaScript wordmark.

Fixes documentation and comment references to capitalize JavaScript in accordance with the wordmark.

Props peterwilsoncc, mukesh27, dmsnell.
See #60699.

#35 @desrosj
3 weeks ago

In 58672:

Docs: Update AJAX in Plugins HelpHub link to avoid unnecessary redirection.

Follow-up to [17045], [20713], [41065], [45674], [55412], [57854], [58131], [58132].

Props shailu25.
See #60732, #60699.

#36 @audrasjb
3 weeks ago

In 58697:

Docs: Update AJAX in Plugins HelpHub link to avoid unnecessary redirection.

Follow-up to [17045], [20713], [41065], [45674], [55412], [57854], [58131], [58132].

Reviewed by desrosj, davidbaumwald.
Merges [58672] to the 6.6 branch.

Props shailu25.
Fixes #60732.
See #60699.

#37 @hellofromTonya
3 weeks ago

  • Resolution set to fixed
  • Status changed from new to closed

The last scheduled RC is happening within <= 1 hour, closing this ticket as fixed.

Thank you everyone for contributing to improving the code's documentation :)

#61608 is now open for the 6.7 cycle.

Note: See TracTickets for help on using tickets.