From d92ac1c2fd7c8480b190eabb1876a62de1b359a0 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Mon, 7 Sep 2009 21:02:03 +0000 Subject: [PATCH] fix docs for syntax-local-name, syntax-local-infer-name, and 'inferred-name svn: r15904 --- collects/scribblings/reference/stx-trans.scrbl | 6 +++--- collects/scribblings/reference/syntax-model.scrbl | 3 ++- collects/syntax/scribblings/name.scrbl | 2 +- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/collects/scribblings/reference/stx-trans.scrbl b/collects/scribblings/reference/stx-trans.scrbl index d747a6898d..8cc971b206 100644 --- a/collects/scribblings/reference/stx-trans.scrbl +++ b/collects/scribblings/reference/stx-trans.scrbl @@ -519,11 +519,11 @@ expanded. within a @scheme[module] form, or if it is not a run-time expression, then the @exnraise[exn:fail:contract]. } -@defproc[(syntax-local-name) (or/c symbol? #f)]{ +@defproc[(syntax-local-name) any/c]{ Returns an inferred name for the expression position being -transformed, or @scheme[#f] if no such name is available. See also -@secref["infernames"]. +transformed, or @scheme[#f] if no such name is available. A name is +normally a symbol or an identifier. See also @secref["infernames"]. @transform-time[]} diff --git a/collects/scribblings/reference/syntax-model.scrbl b/collects/scribblings/reference/syntax-model.scrbl index e67078a38f..2060d83dc3 100644 --- a/collects/scribblings/reference/syntax-model.scrbl +++ b/collects/scribblings/reference/syntax-model.scrbl @@ -853,7 +853,8 @@ the procedure bound to @scheme[my-f] will have the inferred name When an @indexed-scheme['inferred-name] property is attached to a syntax object for an expression (see @secref["stxprops"]), the property value is used for naming the expression, and it overrides any -name that was inferred from the expression's context. +name that was inferred from the expression's context. Normally, the +property value should be a symbol or an identifier. When an inferred name is not available, but a source location is available, a name is constructed using the source location diff --git a/collects/syntax/scribblings/name.scrbl b/collects/syntax/scribblings/name.scrbl index 22135b9910..dab4229af6 100644 --- a/collects/syntax/scribblings/name.scrbl +++ b/collects/syntax/scribblings/name.scrbl @@ -6,7 +6,7 @@ @defmodule[syntax/name] -@defproc[(syntax-local-infer-name [stx syntax?]) (or/c symbol? false/c)]{ +@defproc[(syntax-local-infer-name [stx syntax?]) any/c]{ Similar to @scheme[syntax-local-name] except that @scheme[stx] is checked for an @scheme['inferred-name] property (which overrides any