ca0a5dd96216

Fix documentation
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Sun, 18 Sep 2016 13:03:03 +0000
parents ee7247080256
children 75229fb62b8c
branches/tags (none)
files DOCUMENTATION.markdown

Changes

--- a/DOCUMENTATION.markdown	Sun Sep 18 12:50:45 2016 +0000
+++ b/DOCUMENTATION.markdown	Sun Sep 18 13:03:03 2016 +0000
@@ -253,10 +253,21 @@
 
 Print `args` readably, separated by spaces and followed by a newline.
 
+  Returns the first argument, so you can just wrap it around a form without
+  interfering with the rest of the program.
+
   This is what `print` should have been.
 
   
 
+### `SHUT-UP` (macro)
+
+    (SHUT-UP
+      &BODY
+      BODY)
+
+Run `body` with stdout and stderr redirected to the void.
+
 ## Package `LOSH.DISTRIBUTIONS`
 
 Utilities for calculating statistical... things.
@@ -296,7 +307,7 @@
 
 ### `DEFINE-WITH-MACRO` (macro)
 
-    (DEFINE-WITH-MACRO TYPE &REST SLOTS)
+    (DEFINE-WITH-MACRO TYPE-AND-OPTIONS &REST SLOTS)
 
 Define a with-`type` macro for the given `type` and `slots`.
 
@@ -440,6 +451,23 @@
 
 Custom `iterate` drivers and clauses.
 
+### `MACROEXPAND-ITERATE` (function)
+
+    (MACROEXPAND-ITERATE CLAUSE &OPTIONAL (COCKS :FOO))
+
+Macroexpand the given iterate clause/driver.
+
+  Example:
+
+    (macroexpand-iterate '(averaging (+ x 10) :into avg))
+    =>
+    (PROGN
+     (FOR #:COUNT665 :FROM 0)
+     (FOR AVG :FIRST (+ X 10) :THEN
+      (/ (+ (* AVG #:COUNT665) (+ X 10)) (1+ #:COUNT665))))
+
+  
+
 ## Package `LOSH.LISTS`
 
 Utilities related to lists.