WordPress.org

Make WordPress Core

Opened 7 months ago

Closed 7 weeks ago

Last modified 7 weeks ago

#47110 closed task (blessed) (fixed)

Docblock improvements for 5.3

Reported by: desrosj Owned by:
Milestone: 5.3 Priority: normal
Severity: normal Version:
Component: General Keywords:
Focuses: docs Cc:
PR Number:

Description

Previously:

Attachments (1)

47110.diff (31.7 KB) - added by johnbillion 3 months ago.

Download all attachments as: .zip

Change History (41)

#1 @SergeyBiryukov
7 months ago

In 45304:

Docs: Convert @see reference in WP_REST_Request DocBlock to @link, to avoid a broken link in Developer Reference.

See #47110.

#2 @SergeyBiryukov
7 months ago

In 45377:

Docs: Improve documentation for the_date() and the_weekday_date().

Correct type for $currentday and $previousday globals.

See #47354, #47110.

#3 @SergeyBiryukov
7 months ago

In 45380:

Docs: Adjust get_post_modified_time filter DocBlock for consistency with get_post_time.

See #47110.

#4 @johnbillion
7 months ago

In 45388:

Docs: Remove incorrect information about usage of the "from" filters in wp_mail(), tidy up formatting.

See #47110

#5 @johnbillion
5 months ago

In 45565:

Docs: Correct and improve the docs for a few nonce-related functions.

See #47110

#6 @SergeyBiryukov
5 months ago

In 45642:

Docs: Correct @since tag for do_mu_upgrade hook, for consistency with after_mu_upgrade and wpmu_upgrade_site.

See #47110.

#7 @SergeyBiryukov
4 months ago

In 45695:

Docs: Improve the DocBlocks for got_mod_rewrite(), extract_from_markers(), insert_with_markers().

See #47110.

#8 @SergeyBiryukov
4 months ago

In 45733:

Docs: Fix typo in a comment in WP_Site_Health::get_test_theme_version().

See #47110.

#9 @SergeyBiryukov
4 months ago

In 45735:

Docs: Add missing description for $wp_rewrite global.

See #45604, #47110.

#10 @SergeyBiryukov
4 months ago

In 45736:

Docs: Add missing description for $wp global.

See #45604, #47110.

#11 @SergeyBiryukov
4 months ago

In 45737:

Docs: Add missing description for $wp_locale global.

Props mukesh27.
See #45604, #47110.

#12 @SergeyBiryukov
4 months ago

In 45738:

Docs: Add missing description for $wp_locale_switcher global.

See #45604, #47110.

#13 @SergeyBiryukov
4 months ago

In 45739:

Docs: Add missing description for $wp_query and $wp_the_query globals.

Props mukesh27.
See #45604, #47110.

#14 @SergeyBiryukov
4 months ago

In 45740:

Docs: Add missing description for $current_screen global.

Props mukesh27.
Fixes #45604. See #47110.

#15 @SergeyBiryukov
4 months ago

In 45742:

Docs: Add missing description for $post global.

Props immeet94.
Fixes #46503. See #47110.

#16 @johnbillion
4 months ago

In 45821:

Docs: Add a missing return type.

See #47110

#17 @SergeyBiryukov
3 months ago

In 45895:

Docs: Reference WP_Term_Query::__construct() in wp_list_categories() DocBlock for additional accepted arguments.

Clarify that wp_dropdown_categories() always returns a string, regardless of the echo parameter.

See #47896, #47110.

#18 @SergeyBiryukov
3 months ago

In 45898:

Docs: Remove a clarification from do_robots() description that doesn't really clarify anything.

See #47110.

#19 @johnbillion
3 months ago

In 45915:

Docs: Correct and improve inline docs relating to caching, terms, meta, and some misc tweaks.

See #47110

#20 @SergeyBiryukov
3 months ago

In 45916:

Docs: Update plugin headers example in get_plugin_data() to clarify that Version is not a required field.

Props casiepa.
See #47110, #meta4707.

#21 @SergeyBiryukov
3 months ago

In 45917:

Docs: Simplify get_plugin_data() and get_file_data() description.

See #47110.

#22 @SergeyBiryukov
3 months ago

In 45921:

Twenty Nineteen: Correct file name in JS DocBlocks.

See #47110.

#23 @SergeyBiryukov
3 months ago

In 46069:

Docs: Remove extra spaces in various REST API DocBlocks.

See #47110.

#24 @SergeyBiryukov
3 months ago

In 46088:

Docs: Fix placement of some duplicate hook references.

Hook documentation should be on the line directly above the line containing the do_action() or apply_filters() call. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of duplicate hook references.

Includes minor code layout fixes.

See #47110.

#25 @SergeyBiryukov
3 months ago

In 46089:

Coding Standards: Fix WPCS issue in [46088].

See #47110.

#26 @SergeyBiryukov
3 months ago

In 46150:

Docs: Improve @return value description for wp_xmlrpc_server::minimum_args().

See #47110.

#27 @johnbillion
3 months ago

In 46162:

Docs: Improve docs for upload and wp_die() related functions.

See #47110

#28 @johnbillion
3 months ago

In 46223:

Docs: Improve the docs for comment counting related functions.

See #47110, #48093

@johnbillion
3 months ago

#29 @johnbillion
3 months ago

In 46232:

Docs: Docblock corrections and improvements, mostly related to various pre_* filters.

See #47110

#30 @SergeyBiryukov
2 months ago

In 46288:

Docs: Improve consistency in @since tags for parameters that were made optional.

See #47110.

#31 @SergeyBiryukov
2 months ago

In 46315:

Docs: Improve documentation for _post_states() and get_post_states().

Add documentation for _media_states().

See #47110.

#32 @SergeyBiryukov
2 months ago

In 46391:

Docs: Add missing description for $comment global.

Props immeet94, mukesh27.
Fixes #46928. See #47110.

#33 @SergeyBiryukov
2 months ago

In 46394:

Docs: Improve documentation for get_theme_mod() and set_theme_mod().

See #47110.

#34 @SergeyBiryukov
2 months ago

In 46399:

Docs: Correct formatting of the @return value description in _wp_handle_upload().

See #47110.

#35 @johnbillion
2 months ago

In 46424:

Docs: Miscellaneous inline docs corrections and improvements.

See #47110

#36 @johnbillion
8 weeks ago

In 46468:

Docs: Fix and improve inline documentation for the HTTP API.

See #47110

#37 @peterwilsoncc
8 weeks ago

In 46469:

Docs: Correct comment typo in WP_REST_Terms_Controller::update_item().

Props manikmist09.
Fixes #48295. See #47110.

#38 @peterwilsoncc
8 weeks ago

In 46470:

Docs: Correct documentation typo in print_emoji_detection_script().

Props itowhid06.
Fixes #48298. See #47110.

#39 @desrosj
7 weeks ago

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

With 5.3 RC1 tomorrow, let's close this out to clear the milestone. See everyone in 5.4 for the next episode of Documentation Improvements!

Note: See TracTickets for help on using tickets.