Changeset 53543 for trunk/src/wp-includes/l10n.php

Timestamp:

06/20/2022 10:55:52 PM (4 years ago)

Author:

johnbillion

Message:

I18N: Correct and improve inline docs and tests for functionality related to nooped plurals.

See #55646, #55652

File:

• trunk/src/wp-includes/l10n.php (modified) (3 diffs)

trunk/src/wp-includes/l10n.php

@@ -588 +588 @@
  *     Array of translation information for the strings.
  *
- *     @type string $0        Singular form to be localized. No longer used.
- *     @type string $1        Plural form to be localized. No longer used.
- *     @type string $singular Singular form to be localized.
- *     @type string $plural   Plural form to be localized.
- *     @type null   $context  Context information for the translators.
- *     @type string $domain   Text domain.
+ *     @type string      $0        Singular form to be localized. No longer used.
+ *     @type string      $1        Plural form to be localized. No longer used.
+ *     @type string      $singular Singular form to be localized.
+ *     @type string      $plural   Plural form to be localized.
+ *     @type null        $context  Context information for the translators.
+ *     @type string|null $domain   Text domain.
  * }
  */
@@ -655 +655 @@
 
 /**
- * Translates and retrieves the singular or plural form of a string that's been registered
+ * Translates and returns the singular or plural form of a string that's been registered
  * with _n_noop() or _nx_noop().
  *
@@ -668 +668 @@
  * @since 3.1.0
  *
- * @param array  $nooped_plural Array with singular, plural, and context keys, usually the result of _n_noop() or _nx_noop().
+ * @param array  $nooped_plural {
+ *     Array that is usually a return value from _n_noop() or _nx_noop().
+ *
+ *     @type string      $singular Singular form to be localized.
+ *     @type string      $plural   Plural form to be localized.
+ *     @type string|null $context  Context information for the translators.
+ *     @type string|null $domain   Text domain.
+ * }
  * @param int    $count         Number of objects.
  * @param string $domain        Optional. Text domain. Unique identifier for retrieving translated strings. If $nooped_plural contains
  *                              a text domain passed to _n_noop() or _nx_noop(), it will override this value. Default 'default'.
- * @return string Either $single or $plural translated text.
+ * @return string Either $singular or $plural translated text.
  */
 function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' ) {