Handbook
Glossary
scaffold-docs ( vocab -- )
Scaffold tool
Prev:
scaffold-work ( string -- )
Next:
scaffold-undocumented ( string -- )
Vocabulary
tools.scaffold
Inputs
vocab
a
vocab
Outputs
None
Word description
Takes an existing vocabulary and creates a help file with scaffolded help for each word. This word only works if no help file yet exists.
See also
scaffold-undocumented
,
scaffold-examples
Definition
USING:
kernel
tools.scaffold.private
;
IN:
tools.scaffold
:
scaffold-docs
( vocab -- )
ensure-vocab-exists
[
dup
"-docs.factor"
vocab/suffix>path
scaffolding?
[
set-scaffold-docs-file
]
[
2drop
]
if
]
with-scaffold
;