From 916c495337c3eeb4cc558038a2f115cc8710d297 Mon Sep 17 00:00:00 2001 From: John Benediktsson Date: Fri, 27 Jul 2012 15:24:30 -0700 Subject: [PATCH] tools.scaffold: rename scaffold-help to scaffold-docs. --- basis/tools/scaffold/scaffold-docs.factor | 6 +++--- basis/tools/scaffold/scaffold.factor | 2 +- extra/fuel/fuel.factor | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/basis/tools/scaffold/scaffold-docs.factor b/basis/tools/scaffold/scaffold-docs.factor index db68049efa..271b74b9f7 100644 --- a/basis/tools/scaffold/scaffold-docs.factor +++ b/basis/tools/scaffold/scaffold-docs.factor @@ -12,7 +12,7 @@ HELP: help. { "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." } ; @@ -21,7 +21,7 @@ HELP: scaffold-undocumented { "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 @@ -80,7 +80,7 @@ ARTICLE: "tools.scaffold" "Scaffold tool" { $subsections scaffold-vocab } "Generate help scaffolding:" { $subsections - scaffold-help + scaffold-docs scaffold-undocumented help. } diff --git a/basis/tools/scaffold/scaffold.factor b/basis/tools/scaffold/scaffold.factor index 99a4e720d5..2b3461eb69 100644 --- a/basis/tools/scaffold/scaffold.factor +++ b/basis/tools/scaffold/scaffold.factor @@ -249,7 +249,7 @@ PRIVATE> : help. ( word -- ) [ (help.) ] [ nl vocabulary>> link-vocab ] bi ; -: scaffold-help ( vocab -- ) +: scaffold-docs ( vocab -- ) ensure-vocab-exists [ dup "-docs.factor" vocab/suffix>path scaffolding? [ diff --git a/extra/fuel/fuel.factor b/extra/fuel/fuel.factor index b60f837707..c33f64770a 100644 --- a/extra/fuel/fuel.factor +++ b/extra/fuel/fuel.factor @@ -143,7 +143,7 @@ PRIVATE> 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 -- )