From 2716cc52afce7c59cb470b8d587ae3e9ab75d76e Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Sat, 30 Oct 2021 20:15:59 +0000 Subject: [PATCH] Docs: Miscellaneous docblock improvements. See #53399 git-svn-id: https://develop.svn.wordpress.org/trunk@51957 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/media.php | 2 +- src/wp-includes/functions.php | 7 ++++++- src/wp-includes/general-template.php | 2 +- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/src/wp-admin/includes/media.php b/src/wp-admin/includes/media.php index 3cb96b2bb4..8768c75ee2 100644 --- a/src/wp-admin/includes/media.php +++ b/src/wp-admin/includes/media.php @@ -1521,7 +1521,7 @@ function get_attachment_fields_to_edit( $post, $errors = null ) { * * @global WP_Query $wp_the_query WordPress Query object. * - * @param int $post_id Optional. Post ID. + * @param int $post_id Post ID. * @param array $errors Errors for attachment, if any. * @return string */ diff --git a/src/wp-includes/functions.php b/src/wp-includes/functions.php index 5101e142bf..0950f79465 100644 --- a/src/wp-includes/functions.php +++ b/src/wp-includes/functions.php @@ -565,7 +565,12 @@ function human_readable_duration( $duration = '' ) { * * @param string $mysqlstring Date or datetime field type from MySQL. * @param int|string $start_of_week Optional. Start of the week as an integer. Default empty string. - * @return array Keys are 'start' and 'end'. + * @return int[] { + * Week start and end dates as Unix timestamps. + * + * @type int $start The week start date as a Unix timestamp. + * @type int $end The week end date as a Unix timestamp. + * } */ function get_weekstartend( $mysqlstring, $start_of_week = '' ) { // MySQL string year. diff --git a/src/wp-includes/general-template.php b/src/wp-includes/general-template.php index 4ab79e8ddc..4a9835a478 100644 --- a/src/wp-includes/general-template.php +++ b/src/wp-includes/general-template.php @@ -189,7 +189,7 @@ function get_template_part( $slug, $name = null, $args = array() ) { $templates[] = "{$slug}.php"; /** - * Fires before a template part is loaded. + * Fires before an attempt is made to locate and load a template part. * * @since 5.2.0 * @since 5.5.0 The `$args` parameter was added.