[FIX] core: documentation of flush()

X-original-commit: 60c01cac4f272392cce534302f2ecba4918008d2
2020-09-03 13:42:15 +00:00
parent e7ee28cb67
commit 773b98cfd7
1 changed files with 7 additions and 3 deletions
@@ -5330,9 +5330,13 @@ Fields:

    @api.model
    def flush(self, fnames=None, records=None):
-        """ Process all the pending recomputations (or at least the given field
-            names `fnames` if present) and flush the pending updates to the
-            database.
+        """ Process all the pending computations (on all models), and flush all
+        the pending updates to the database.
+
+        :param fnames (list<str>): list of field names to flush.  If given,
+            limit the processing to the given fields of the current model.
+        :param records (Model): if given (together with ``fnames``), limit the
+            processing to the given records.
        """
        def process(model, id_vals):
            # group record ids by vals, to update in batch when possible