(NFC) CRM_Utils_Hook::translateFields - Tidy up comments
authorTim Otten <totten@civicrm.org>
Thu, 3 Jun 2021 00:51:05 +0000 (17:51 -0700)
committerTim Otten <totten@civicrm.org>
Thu, 3 Jun 2021 00:51:05 +0000 (17:51 -0700)
The previous comments reflected a developmental iteration.

CRM/Utils/Hook.php

index 93595de721778414fedefec9b59b075acd840b41..f1da9afb10f85c492c4fdc1cf874762eae83ab08 100644 (file)
@@ -1811,13 +1811,9 @@ abstract class CRM_Utils_Hook {
    * @param array $fields
    *   List of data fields to translate, organized by table and column.
    *   Omitted/unlisted fields are not translated. Any listed field may be translated.
-   *   Values should be TRUE-ish.
+   *   Values should be TRUE.
    *   Ex: $fields['civicrm_event']['summary'] = TRUE
-   *   Ex: $fields['civicrm_event']['summary'] = 'yesplease';
-   *
-   * At time of writing, the `$fields` list x is prepopulated based on `<localizable>` fields in core's `xml/schema`.
-   * In the future, it may also be prepopulated with `<localizable>` fields in ext's `xml/schema`.
-   * For the interim, you may wish to fill-in `<localizable>` fields from ext's.
+   * @return mixed
    */
   public static function translateFields(&$fields) {
     return self::singleton()->invoke(['fields'], $fields, self::$_nullObject,