From 46379331900e97c2938695d7b9b537a107c6e8ee Mon Sep 17 00:00:00 2001
From: Vladimir Sedach <vsedach@gmail.com>
Date: Tue, 1 Nov 2011 21:24:05 -0400
Subject: [PATCH] Added documentation for *default-future-type* to readme

---
 README | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README b/README
index a4e6c5b..481e3ee 100644
--- a/README
+++ b/README
@@ -55,6 +55,14 @@ function pcall (thunk &optional (future-type *default-future-type*)) => future
 
   The function is called in an unspecified dynamic environment.
 
+special variable *default-future-type*
+
+  One of :eager, :speculative (default) or :lazy. If eager, any newly
+  created futures start their computation immediately. If speculative,
+  newly created futures are computed when thread pool threads are
+  available, in FIFO future creation order. If lazy, newly created
+  futures are not computed until asked to yield their values.
+
 function ready-to-yield? (future) => nil or non-nil
 
   Returns non-nil if the future values have been computed, nil otherwise.
-- 
GitLab