Permalink
Browse files

tweaking markdown documentation

  • Loading branch information...
1 parent 31287e6 commit 4e5dae4cf9d8981a325f4f11da68daded6502396 Nick Allen committed Mar 28, 2009
Showing with 17 additions and 3 deletions.
  1. +17 −3 README.md
View
@@ -63,7 +63,7 @@ The existence of pretty functions in a lisp image does not create any more work
- - -
-* `ENABLE-PRETTY-FUNCTION-PRINTING (&optional (priority 0) (table *print-pprint-dispatch*))
+* `ENABLE-PRETTY-FUNCTION-PRINTING (&optional (priority 0) (table *print-pprint-dispatch*))`
_Function_ that modifies the pprint dispatch table `TABLE` to pprint functions using their pretty function printer (see `GET-FUNCTION-PRINTER`).
@@ -75,13 +75,15 @@ The existence of pretty functions in a lisp image does not create any more work
for info in its arguments, see Common Lisp's `SET-PPRINT-DISPATCH`.
+- - -
+
* `NAMED-LAMBDA (name lambda-list &body body)`
_Macro_ like `LAMBDA` except the resultant function is prittern as
#<named-lambda NAME>
- when pprinted to a stream and pretty printing functions has been enabled (see `ENABLE-PRETTy-FUNCTION-PRINTING).
+ when pprinted to a stream and pretty printing functions has been enabled (see `ENABLE-PRETTy-FUNCTION-PRINTING`).
`NAME` is not evaluated.
@@ -93,12 +95,16 @@ The existence of pretty functions in a lisp image does not create any more work
but
- ((named-lambda mistake (a b) (+ a b)) 5 6) ==> THROWS AN ERROR
+ ((named-lambda mistake (a b) (+ a b)) 5 6) ==> THROWS AN ERROR
+
+- - -
* `NAMED-LAMBDA (name-form lambda-list &body body)`
_Macro_ like `NAMED-LAMBDA` except `NAME-FORM` is evaluated
+- - -
+
* `WITH-FUNCTION-PRINTER (printer fn-form)`
_Macro_ returns the result of evaluating `FN-FORM`, which should return a function.
@@ -121,20 +127,28 @@ The existence of pretty functions in a lisp image does not create any more work
CL-USER> x
#<counter 1>
+- - -
+
* `*PRETTY-FUNCTION-PRINTING-SUPPORTED-P*`
_Variable_. Is `T` on implementations that support pretty function printing, `NIL, on the rest.
+- - -
+
* `PRINT-PRETTY-FUNCTION-TABLE (&optional (stream *standard-output*))`
_Function_. prints all known pretty functions to `STREAM`
+- - -
+
* `CLEAR-PRETTY-FUNCTION-TABLE ()`
_Function_ that turns all known pretty functions into normal, non-pretty functions.
Individual pretty functions can also be turned back into normal functions by `SETF`-ing their `GET-FUNCTION-PRINTER` to `NIL`
+- - -
+
* `GET-FUNCTION-PRINTER (function)`
`SETF`-able _Function_ for accessing the pretty function printer of `FUNCTION` or `NIL` if `FUNCTION` is not a pretty function.

0 comments on commit 4e5dae4

Please sign in to comment.