suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix some docs. Add an example too.

Browse Source
This commit is contained in:
Asumu Takikawa 2012-11-19 15:38:13 -05:00
parent 3e505af4f9
commit dc609f46f0
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
collects/xml/xml.scrbl
View File

@ -312,13 +312,19 @@ are not named in the @racket[tags] list. Using @racket[(lambda (x) #t)] as
@racket[choose] filters all elements regardless of the @racket[tags] @racket[choose] filters all elements regardless of the @racket[tags]
list.} list.}
@defproc[(validate-xexpr [v any/c]) (one-of/c #t)]{ @defproc[(validate-xexpr [v any/c]) #t]{
If @racket[v] is an @tech{X-expression}, the result If @racket[v] is an @tech{X-expression}, the result is
@racket[#t]. Otherwise, @racket[exn:invalid-xexpr]s is raised, with @racket[#t]. Otherwise, @racket[exn:invalid-xexpr]s is raised, with
the a message of the form ``Expected @nonterm{something}, given a message of the form ``Expected @nonterm{something}, given
@nonterm{something-else}/'' The @racket[code] field of the exception @nonterm{something-else}''. The @racket[code] field of the exception
is the part of @racket[v] that caused the exception.} is the part of @racket[v] that caused the exception.
@examples[#:eval xml-eval
(validate-xexpr '(doc () "over " (em () "9000") "!"))
(validate-xexpr #\newline)
]
}
@defproc[(correct-xexpr? [v any/c] @defproc[(correct-xexpr? [v any/c]
[success-k (-> any/c)] [success-k (-> any/c)]
@ -328,7 +334,7 @@ is the part of @racket[v] that caused the exception.}
Like @racket[validate-xexpr], except that @racket[success-k] is called Like @racket[validate-xexpr], except that @racket[success-k] is called
on each valid leaf, and @racket[fail-k] is called on invalid leaves; on each valid leaf, and @racket[fail-k] is called on invalid leaves;
the @racket[fail-k] may return a value instead of raising an exception the @racket[fail-k] may return a value instead of raising an exception
of otherwise escaping. Results from the leaves are combined with or otherwise escaping. Results from the leaves are combined with
@racket[and] to arrive at the final result.} @racket[and] to arrive at the final result.}
@; ---------------------------------------------------------------------- @; ----------------------------------------------------------------------