From e8bc0420eaad84a6272ca8112cb1b5b51a2b84ea Mon Sep 17 00:00:00 2001 From: AlexKnauth Date: Sun, 19 Jun 2016 21:51:45 -0400 Subject: [PATCH] document mandatory #:outer-scope argument --- afl/docs/afl.scrbl | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/afl/docs/afl.scrbl b/afl/docs/afl.scrbl index 960892d..4d66e31 100644 --- 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]. }