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

Adjust prose in how-to-doc section of Scribble docs

Browse Source 
original commit: 50711f7a6e570300cbdcb2b8979c93878bacac68
This commit is contained in:
Asumu Takikawa 2014-02-07 00:10:27 -05:00
parent 2064749fa2
commit ec6eb40ce8
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to.scrbl
View File

@ -300,15 +300,14 @@ on forms to document Racket bindings.
@section{Showing Racket Examples}
The @racket[examples] form from @racket[scribble/eval]
helps you generate examples in your documentation. @bold{Warning:} the
@racket[examples] form is especially likely to change or be replaced.
helps you generate examples in your documentation.
To use @racket[examples], the procedures to document must be suitable
for use at documentation time; in fact, @racket[examples] uses
bindings introduced into the document source by
@racket[require]. Thus, to generate examples using @racket[my-helper]
from the previous section, @filepath{helper.rkt} must be imported both
via @racket[require-for-label] and @racket[require]:
via @racket[(require (for-label ....))] and @racket[require]:
@verbatim[#:indent 2]|{
#lang scribble/manual