commit 47bab9943d1fb4ae85dcb21b645881d899509271
parent 5d67e0fe48631d9747db5a13e6e549192752544c
Author: Matthew Flatt <mflatt@racket-lang.org>
Date: Tue, 23 Aug 2011 07:53:22 -0600
doc style adjustments; reorg cmdline+editors docs in Guide
original commit: f082919f0b63ec0bb40f2b3532796eabdeafee11
Diffstat:
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/collects/scribblings/scribble/base.scrbl b/collects/scribblings/scribble/base.scrbl
@@ -131,14 +131,18 @@ show the author(s) of a document, where each author is represented by
@racket[title] for the beginning of a document. See also
@racket[author+email].}
-@defproc[(author+email [author elem]
+@defproc[(author+email [author-name elem]
[email string?]
[#:obfuscate? obfuscate? any/c #f])
element?]{
Combines an author name with an e-mail address. If @racket[obfuscate?]
is true, then the result obscures the e-mail address slightly to avoid
-address-harvesting robots.}
+address-harvesting robots.
+
+Note that @racket[author+email] is not a replacement for
+@racket[author]. The @racket[author+email] function is often used in
+combination with @racket[author].}
@; ------------------------------------------------------------------------