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

fix proc-doc/names documentation

Browse Source 
closes PR 12739

original commit: f2816e72b4a106399ea075988d337c6ab0f38076
This commit is contained in:
Robby Findler 2012-05-03 11:34:37 -05:00
parent c89374a441
commit 95575d09b0
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
collects/scribblings/scribble/srcdoc.scrbl
View File

@ -68,9 +68,10 @@ to get core Racket forms and basic Scribble functions to use in
documentation expressions.} documentation expressions.}
@defform*/subs[#:literals (-> ->* case->) @defform*/subs[#:literals (-> ->* case->)
[(proc-doc/names id contract ((arg-id ...) ((arg-id default-expr) ...)) [(proc-doc/names id contract arg-specs desc-expr)]
desc-expr)] ([arg-specs ((arg-id ...) ((arg-id default-expr) ...))
([contract (-> arg ... result) (arg-id ...)]
[contract (-> arg ... result)
(->* (mandatory ...) (optional ...) result) (->* (mandatory ...) (optional ...) result)
(case-> (-> arg ... result) ...)] (case-> (-> arg ... result) ...)]
[mandatory contract-expr [mandatory contract-expr
@ -82,11 +83,14 @@ When used in @racket[provide/doc], exports @racket[id] with the
contract described by @racket[contract] contract described by @racket[contract]
just like using @racket[provide/contract]. just like using @racket[provide/contract].
The @racket[arg-id]s specify the names of arguments, which are not The @racket[arg-spec] specifies the names of arguments and the
default values, which are not
normally written as part of a contract. They are combined with the normally written as part of a contract. They are combined with the
contract expression to generate the description of the binding in the contract expression to generate the description of the binding in the
documentation via @racket[defproc]. The @racket[(arg-id default-expr)] documentation via @racket[defproc]. The @racket[(arg-id default-expr)]
pairs specify the names and default values of the optional arguments. pairs specify the names and default values of the optional arguments.
If the contract supports optional arguments, then the first
@racket[arg-spec]s form must be used, otherwise the second must be used.
The @racket[desc-expr] is a documentation-time expression that The @racket[desc-expr] is a documentation-time expression that
produces prose to describe the exported binding---that is, the last produces prose to describe the exported binding---that is, the last