Changeset 54855 for trunk/tests/phpunit/tests/functions/wpListUtil.php

Timestamp:

11/17/2022 06:13:47 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update various DocBlocks and inline comments per the documentation standards.

Includes minor formatting edits for consistency.

Follow-up to [53/tests], [12179], [12946], [35288], [37884], [38810], [38928], [46596], [48131], [52955], [53548], [53813], [53873], [54118], [54316], [54420], [54421], [54803].

See #56792.

File:

• trunk/tests/phpunit/tests/functions/wpListUtil.php (modified) (3 diffs)

trunk/tests/phpunit/tests/functions/wpListUtil.php

@@ -65 +65 @@
      * @param string $target_key   The key to pluck.
      * @param array  $expected     The expected array.
-     * @param string $index_key    Optional. Field from the element to use as keys for the new array. Default null.
+     * @param string $index_key    Optional. Field from the element to use as keys for the new array.
+     *                             Default null.
      */
     public function test_wp_list_util_pluck( $target_array, $target_key, $expected, $index_key = null ) {
@@ -157 +158 @@
      * @param array  $expected      The expected array.
      * @param array  $target_array  The array to create a list from.
-     * @param array  $orderby       Optional. Either the field name to order by or an array of multiple orderby fields as $orderby => $order.
+     * @param array  $orderby       Optional. Either the field name to order by or an array
+     *                              of multiple orderby fields as `$orderby => $order`.
      *                              Default empty array.
-     * @param string $order         Optional. Either 'ASC' or 'DESC'. Only used if $orderby is a string. Default 'ASC'.
+     * @param string $order         Optional. Either 'ASC' or 'DESC'. Only used if `$orderby`
+     *                              is a string. Default 'ASC'.
      * @param bool   $preserve_keys Optional. Whether to preserve keys. Default false.
      */
@@ -956 +959 @@
      * @param array  $expected      The expected array.
      * @param array  $target_array  The array to create a list from.
-     * @param array  $orderby       Optional. Either the field name to order by or an array of multiple orderby fields as $orderby => $order.
+     * @param array  $orderby       Optional. Either the field name to order by or an array
+     *                              of multiple orderby fields as `$orderby => $order`.
      *                              Default empty array.
-     * @param string $order         Optional. Either 'ASC' or 'DESC'. Only used if $orderby is a string. Default 'ASC'.
+     * @param string $order         Optional. Either 'ASC' or 'DESC'. Only used if `$orderby`
+     *                              is a string. Default 'ASC'.
      * @param bool   $preserve_keys Optional. Whether to preserve keys. Default false.
      */