tools.scaffold: rename scaffold-help to scaffold-docs.

db4
John Benediktsson 2012-07-27 15:24:30 -07:00
parent 95015c7bc6
commit 916c495337
3 changed files with 5 additions and 5 deletions

View File

@ -12,7 +12,7 @@ HELP: help.
{ "word" word } } { "word" word } }
{ $description "Prints out scaffold help markup for a given word." } ; { $description "Prints out scaffold help markup for a given word." } ;
HELP: scaffold-help HELP: scaffold-docs
{ $values { "vocab" vocab } } { $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." } ; { $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." } ;
@ -21,7 +21,7 @@ HELP: scaffold-undocumented
{ "string" string } } { "string" string } }
{ $description "Prints scaffolding documentation for undocumented words in a vocabulary except for automatically generated class predicates." } ; { $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 HELP: scaffold-authors
{ $values { $values
@ -80,7 +80,7 @@ ARTICLE: "tools.scaffold" "Scaffold tool"
{ $subsections scaffold-vocab } { $subsections scaffold-vocab }
"Generate help scaffolding:" "Generate help scaffolding:"
{ $subsections { $subsections
scaffold-help scaffold-docs
scaffold-undocumented scaffold-undocumented
help. help.
} }

View File

@ -249,7 +249,7 @@ PRIVATE>
: help. ( word -- ) : help. ( word -- )
[ (help.) ] [ nl vocabulary>> link-vocab ] bi ; [ (help.) ] [ nl vocabulary>> link-vocab ] bi ;
: scaffold-help ( vocab -- ) : scaffold-docs ( vocab -- )
ensure-vocab-exists ensure-vocab-exists
[ [
dup "-docs.factor" vocab/suffix>path scaffolding? [ dup "-docs.factor" vocab/suffix>path scaffolding? [

View File

@ -143,7 +143,7 @@ PRIVATE>
dup require vocab-source-path absolute-path fuel-eval-set-result ; dup require vocab-source-path absolute-path fuel-eval-set-result ;
: fuel-scaffold-help ( name devname -- ) : 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 ; vocab-docs-path absolute-path fuel-eval-set-result ;
: fuel-scaffold-tests ( name devname -- ) : fuel-scaffold-tests ( name devname -- )