www

commit e8bc0420eaad84a6272ca8112cb1b5b51a2b84ea
parent bbac4b9abb831c503a9f507e509d28e2168681c0
Author: AlexKnauth <alexander@knauth.org>
Date:   Sun, 19 Jun 2016 21:51:45 -0400

document mandatory #:outer-scope argument

Diffstat:
M
afl/docs/afl.scrbl
 | 
5
+++++

1 file changed, 5 insertions(+), 0 deletions(-)
diff --git a/afl/docs/afl.scrbl b/afl/docs/afl.scrbl
@@ -67,9 +67,14 @@ The @racket[arg-str] argument lets you specify something else to use as a placeh
 }
 
 @defproc[(make-afl-readtable [orig-readtable readtable? (current-readtable)]
+                             [#:outer-scope outer-scope (-> syntax? syntax?)]
                              [#:arg-str arg-str string? (current-arg-string)]) readtable?]{
 makes an @racketmodname[afl] readtable based on @racket[orig-readtable].
 
+The @racket[outer-scope] argument should be a function that introduce scopes to preserve hygiene,
+normally produced by @racket[make-syntax-introducer] and similar functions. For versions of racket
+that support it, these should generally be specified as use-site scopes.
+
 The @racket[arg-str] argument lets you specify something else to use as a placeholder instead of
 @racket[%], just like for @racket[afl-read].
 }