Changeset 30611

Timestamp:

11/28/2014 11:26:00 AM (10 years ago)

Author:

DrewAPicture

Message:

4.1 Docs Audit: Improve inline documentation in various WP_Date_Query methods modified in 4.1.

See #30469.

File:

• trunk/src/wp-includes/date.php (modified) (4 diffs)

trunk/src/wp-includes/date.php

@@ -127 +127 @@
      *                                               Accepts numbers 1-7 (1 is Sunday).
      *             @type int          $dayofweek_iso Optional. The day number of the week (ISO). Accepts numbers 1-7
-     *                                               (1 is Monday).Default empty.
+     *                                               (1 is Monday). Default empty.
      *             @type int          $hour          Optional. The hour of the day. Default empty. Accepts numbers 0-23.
      *             @type int          $minute        Optional. The minute of the hour. Default empty. Accepts
@@ -181 +181 @@
      * Ensures that each query-level clause has a 'relation' key, and that
      * each first-order clause contains all the necessary keys from
-     * $defaults.
+     * `$defaults`.
      *
      * @since 4.1.0
      * @access public
      *
-     * @param  array $query A tax_query query clause.
+     * @param array $query A tax_query query clause.
      * @return array Sanitized queries.
      */
@@ -481 +481 @@
              *
              * @param array $valid_columns An array of valid date query columns. Defaults
-             *                 are 'post_date', 'post_date_gmt', 'post_modified',
-             *                 'post_modified_gmt', 'comment_date', 'comment_date_gmt',
-             *                 'user_registered'
+             *                             are 'post_date', 'post_date_gmt', 'post_modified',
+             *                             'post_modified_gmt', 'comment_date', 'comment_date_gmt',
+             *                             'user_registered'
              */
             if ( ! in_array( $column, apply_filters( 'date_query_valid_columns', $valid_columns ) ) ) {
@@ -580 +580 @@
      * @param array $query Query to parse.
      * @param int   $depth Optional. Number of tree levels deep we currently are.
-     *                     Used to calculate indentation.
+     *                     Used to calculate indentation. Default 0.
      * @return array {
      *     Array containing JOIN and WHERE SQL clauses to append to a single query array.