Handbook
Glossary
scaffold-examples ( word -- )
Scaffold tool
Prev:
scaffold-undocumented ( string -- )
Next:
scaffold-n-examples ( n word -- )
Vocabulary
tools
.
scaffold
Inputs
word
a
word
Outputs
None
Word description
Create some examples for a word with a using list that includes vocabularies the word is in and the
prettyprint
vocabulary. You are then expected to change the header
Example:
to something more descriptive.
Examples
Create docs for the + word:
USING: math tools.scaffold prettyprint ; \ + scaffold-examples
{ $examples "Example:" { $example "USING: math prettyprint ;" "" "" } "Example:" { $example "USING: math prettyprint ;" "" "" } }
See also
scaffold-docs
,
scaffold-undocumented
Definition
USING:
kernel
;
IN:
tools.scaffold
:
scaffold-examples
( word -- )
2
swap
scaffold-n-examples
;