Clearer docblock description of the defaults param

[civicrm-core.git] / Civi / Api4 / Generic / AbstractSaveAction.php

diff --git a/Civi/Api4/Generic/AbstractSaveAction.php b/Civi/Api4/Generic/AbstractSaveAction.php
index 062beb792661623d37a7f37c6a17caa33ee58ad2..a644cc459ca7724fb89a87e99791e13e88f35c1c 100644 (file)
--- a/Civi/Api4/Generic/AbstractSaveAction.php
+++ b/Civi/Api4/Generic/AbstractSaveAction.php
@@ -48,7 +48,9 @@ abstract class AbstractSaveAction extends AbstractAction {
   /**
    * Array of default values.
    *
-   * These defaults will be applied to all $ENTITYs unless they specify otherwise.
+   * These defaults will be merged into every $ENTITY in `records` before saving.
+   * Values set in `records` will override these defaults if set in both places,
+   * but updating existing $ENTITYs will overwrite current values with these defaults.
    *
    * @var array
    */