{ "word" word } }
{ $description "Prints out scaffold help markup for a given word." } ;
-HELP: scaffold-help
+HELP: scaffold-docs
{ $values { "vocab" vocab } }
{ $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." } ;
{ "string" string } }
{ $description "Prints scaffolding documentation for undocumented words in a vocabulary except for automatically generated class predicates." } ;
-{ scaffold-help scaffold-undocumented } related-words
+{ scaffold-docs scaffold-undocumented } related-words
HELP: scaffold-authors
{ $values
{ $subsections scaffold-vocab }
"Generate help scaffolding:"
{ $subsections
- scaffold-help
+ scaffold-docs
scaffold-undocumented
help.
}
: help. ( word -- )
[ (help.) ] [ nl vocabulary>> link-vocab ] bi ;
-: scaffold-help ( vocab -- )
+: scaffold-docs ( vocab -- )
ensure-vocab-exists
[
dup "-docs.factor" vocab/suffix>path scaffolding? [
dup require vocab-source-path absolute-path fuel-eval-set-result ;
: fuel-scaffold-help ( name devname -- )
- [ fuel-scaffold-name dup require dup scaffold-help ] with-scope
+ [ fuel-scaffold-name dup require dup scaffold-docs ] with-scope
vocab-docs-path absolute-path fuel-eval-set-result ;
: fuel-scaffold-tests ( name devname -- )