From ec6eb40ce84c40a1869a8062790796f6a23492bb Mon Sep 17 00:00:00 2001 From: Asumu Takikawa Date: Fri, 7 Feb 2014 00:10:27 -0500 Subject: [PATCH] Adjust prose in how-to-doc section of Scribble docs original commit: 50711f7a6e570300cbdcb2b8979c93878bacac68 --- .../scribble-doc/scribblings/scribble/how-to.scrbl | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to.scrbl b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to.scrbl index 4f24da3a..3e96babb 100644 --- a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to.scrbl +++ b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/how-to.scrbl @@ -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