suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Add doc examples for @author and @author+email

Browse Source
This commit is contained in:
Asumu Takikawa 2017-09-08 12:35:18 -07:00
parent 7f8004be1f
commit 77a46f46c7
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
scribble-doc/scribblings/scribble/base.scrbl
View File

@ -130,7 +130,14 @@ Generates a @racket[paragraph] with style name @racket['author] to
show the author(s) of a document, where each author is represented by
@tech{content}. Normally, this function is used after
@racket[title] for the beginning of a document. See also
@racket[author+email].}
@racket[author+email].
Examples:
@codeblock[#:keep-lang-line? #f]|{
#lang scribble/base
@author{Alice P. Racketeer}
}|}
@defproc[(author+email [author-name content?]
[email string?]
@ -143,7 +150,14 @@ 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].}
combination with @racket[author].
Examples:
@codeblock[#:keep-lang-line? #f]|{
#lang scribble/base
@author[(author+email "Bob T. Scribbler" "bob@racket-lang.org")]
}|}
@; ------------------------------------------------------------------------