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

doc: explain typeset-code's #:block argument

Browse Source
This commit is contained in:
Ben Greenman 2019-02-24 18:20:11 -05:00
parent 3349b13825
commit ac37653988
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
scribble-doc/scribblings/scribble/manual.scrbl
View File

@ -184,13 +184,14 @@ produces the typeset result
[#:keep-lang-line? keep? any/c #t] [#:keep-lang-line? keep? any/c #t]
[#:line-numbers line-numbers (or/c #f exact-nonnegative-integer?) #f] [#:line-numbers line-numbers (or/c #f exact-nonnegative-integer?) #f]
[#:line-number-sep line-number-sep exact-nonnegative-integer? 1] [#:line-number-sep line-number-sep exact-nonnegative-integer? 1]
[#:block? block? any/c #t] [#:block? return-block? any/c #t]
[strs string?] ...) [strs string?] ...)
block?]{ (if return-block? block? element?)]{
A function-based version of @racket[codeblock], allowing you to compute the @racket[strs] arguments. A function-based version of @racket[codeblock], allowing you to compute the @racket[strs] arguments.
Unlike @racket[codeblock], the default @racket[context] argument (@racket[#f]) implies that Unlike @racket[codeblock], the default @racket[context] argument (@racket[#f]) implies that
the context is untouched. The other arguments are treated the same way. the context is untouched and the @racket[return-block?] argument determines the result
structure. The other arguments are treated the same way as @racket[codeblock].
} }
@; ---------------------------------------- @; ----------------------------------------