]> gitweb.factorcode.org Git - factor.git/commitdiff
help: minor doc fixes
authorJohn Benediktsson <mrjbq7@gmail.com>
Tue, 31 Jan 2023 19:46:14 +0000 (11:46 -0800)
committerJohn Benediktsson <mrjbq7@gmail.com>
Tue, 31 Jan 2023 19:46:14 +0000 (11:46 -0800)
basis/help/tour/tour.factor
basis/ui/render/render-docs.factor
extra/fuel/help/help-docs.factor

index 0728d92d73c4cea65331226a1373752c87bea04b..c532cba3e8924f6592d54b5e939b24601e508d55 100644 (file)
@@ -639,9 +639,9 @@ them, which are embodied in the listener. Many functions of the listener can be
 You have seen some examples of this:
 
 { $list
-  {  " The help is navigable online, but you can also invoke it with "  { $link help }  " and print help items with "  { $link print-content }  " ; "  }
-  {  " The "  { $snippet  "F2"  }  " shortcut or the words "  { $link refresh }  " and "  { $link refresh-all }  " can be used to refresh vocabularies from disk while continuing working in the listener; "  }
-  {  " The "  { $link edit  }  " word gives you editor integration, but you can also click on file names in the help pages for vocabularies to open them. "  }
+  { "The help is navigable online, but you can also invoke it with "  { $link help }  " and print help items with "  { $link print-content }  " ; "  }
+  { "The "  { $snippet  "F2"  }  " shortcut or the words "  { $link refresh }  " and "  { $link refresh-all }  " can be used to refresh vocabularies from disk while continuing working in the listener; "  }
+  { "The "  { $link edit  }  " word gives you editor integration, but you can also click on file names in the help pages for vocabularies to open them. "  }
 }
 
 The refresh is an efficient mechanism. Whenever a word is redefined, words that depend on it are recompiled against the new 
index 2c59df783093bfa023eab9434993c4e52e265e5b..e0962bd8e8cc31b4c713c83af750b062709c796f 100644 (file)
@@ -24,7 +24,7 @@ HELP: gadget
         { "clipped?" "a boolean indicating if clipping will be enabled when drawing this gadget's children." }
         { "interior" { "an implementation of the " { $link "ui-pen-protocol" } } }
         { "boundary" { "an implementation of the " { $link "ui-pen-protocol" } } }
-        {  "model" { "a " { $link model } " or " { $link f } "; see " { $link "ui-control-impl" } } }
+        { "model" { "a " { $link model } " or " { $link f } "; see " { $link "ui-control-impl" } } }
     }
 "Gadgets subclass the " { $link rect } " class, and thus all instances have " { $slot "loc" } " and " { $slot "dim" } " instances holding their location and dimensions." }
 { $notes
index 0aff60a5c724d05bc8165eed522af375e6f6937f..b691f59bc1b6812110fed655f132c6e0ce8b41ea 100644 (file)
@@ -1,8 +1,8 @@
-USING: fuel.help.private help.markup help.syntax sequences strings ;
+USING: fuel.help.private help.markup help.syntax sequences strings words ;
 IN: fuel.help
 
 HELP: article-parents
-{ $values { "article-name" string } {  "parents" sequence } }
+{ $values { "article-name" string } { "parents" sequence } }
 { $description "All the parent articles for the article and ensures that the ancestor always is 'handbook'." } ;
 
 HELP:  get-article
@@ -10,7 +10,7 @@ HELP:  get-article
 { $description "If an article and a vocab share name, we render the vocab instead." } ;
 
 HELP: find-word
-{ $values { "name" string } { "word/f" "word or f" } }
+{ $values { "name" string } { "word/f" { $maybe word } } }
 { $description "Prefer to use search which takes the execution context into account. If that fails, fall back on a search of all words." } ;
 
 HELP: vocab-element