From 390d6181d989365f3ed1dd1c7a7d0daa2ef56877 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20Grubbstr=C3=B6m=20=28Grubba=29?=
 <grubba@grubba.org>
Date: Tue, 25 Aug 2020 14:37:25 +0200
Subject: [PATCH] Concurrent.AggregateState: Added CAVEAT LECTOR.

---
 lib/modules/Concurrent.pmod | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/lib/modules/Concurrent.pmod b/lib/modules/Concurrent.pmod
index a50e8c0416..6304cbb11b 100644
--- a/lib/modules/Concurrent.pmod
+++ b/lib/modules/Concurrent.pmod
@@ -754,7 +754,14 @@ class AggregateState
   private Promise promise;
   private int(0..) promises;
   private int(0..) succeeded, failed;
+
+  // CAVEAT LECTOR:
+  //   Before materialize() results contains an array of Futures.
+  //   After it is either set to 0 (if there is a fold_fun),
+  //   or retained with its elements successively replaced by
+  //   their results.
   final array(mixed) results;
+
   final int(0..) min_failures;
   final int(-1..) max_failures;
   final mixed accumulator;
-- 
GitLab