.

akkartik · akkartik · commit f67604ab4667 · 2014-05-09T22:51:00.000-07:00
diff --git a/ac.scm b/ac.scm
@@ -1202,7 +1202,7 @@
 (define (tl)
   (let ((interactive? (terminal-port? (current-input-port))))
     (when interactive?
-      (display "Use (quit) or ^D to quit, (tl) to return here after an interrupt.\n"))
+      (display "Use (quit) or ^D to quit, (tl) to return here after an interrupt, (help _sym_) for docs and examples.\n"))
     (tl2 interactive?)))
 
 (define (tl2 interactive?)
diff --git a/arc.arc b/arc.arc
@@ -78,7 +78,39 @@ Or come ask questions at http://arclanguage.org/forum"
 (mac examples (name . tests-and-expected-results)
 "Shows some example calls of a function as an enhancement of its docstring.
 Usually provided immediately after a function docstring+definition, so it
-isn't underfoot when it isn't needed."
+isn't underfoot when it isn't needed.
+
+Usage: (examples name-being-tested
+          expr1
+          expected-result1
+          expr2
+          expected-result2
+          ...)
+
+Expected results are optional. When provided, they can remind you when
+documentation goes out of date. To avoid printing and checking them, use an _
+wildcard. For example:
+
+  (examples foo
+    (foo x)
+    _
+    (foo y z)
+    _)
+
+Expected results are compared directly, without evaluation. For example:
+
+  (def foo (a b c)
+    (list a b c))
+
+  (examples foo
+    (foo 1 2 3)
+    (1 2 3))            <-- no quote
+
+If the result is an object that read can't handle, use valueof. For example:
+
+  (examples foo
+    (foo x)
+    (valueof (obj a x)))"
   `(sref examples* ',tests-and-expected-results ',name))
 
 (mac do args
diff --git a/lib/help.arc b/lib/help.arc
@@ -77,12 +77,3 @@
   (if (isa x 'string)
     (do (write x) (prn))
     (prn x)))
-
-(def fns ((o test))
-  " Print sigs for macros & functions whose names (as symbols) match `test'.
-    If `test' is a function, it is used as a predicate.
-    Otherwise, names of which `(string test)' is a prefix pass. "
-  (let test (if (isa test 'fn) test
-              (let pfx string.test [begins string._ pfx]))
-    (each f (sort < (keep test keys.sig*))
-      (pr (helpstr sym.f nil)))))
