]> gitweb.factorcode.org Git - factor.git/commitdiff
docs: minor fixes and amendments.
authorAlexander Iljin <ajsoft@yandex.ru>
Wed, 4 May 2016 23:04:40 +0000 (02:04 +0300)
committerJohn Benediktsson <mrjbq7@gmail.com>
Sun, 22 May 2016 14:53:21 +0000 (07:53 -0700)
basis/io/launcher/launcher-docs.factor
basis/models/arrow/arrow-docs.factor
basis/stack-checker/stack-checker-docs.factor
basis/timers/timers-docs.factor
basis/ui/gestures/gestures-docs.factor
core/words/words-docs.factor

index c26ffbfeaa0cbbce1d09c365efe745e31f162178..15a60e46c51e15538656f3a95a75df9af3ef2acd 100644 (file)
@@ -28,10 +28,10 @@ $nl
 "To specify redirection, set the " { $snippet "stdin" } ", " { $snippet "stdout" } " and " { $snippet "stderr" } " slots of a " { $link process } " to one of the following values:"
 { $list
     { { $link f } " - default value; the stream is either inherited from the current process, or is a " { $link <process-stream> } " pipe" }
-    { { $link +closed+ } " - the stream is closed; reads will return end of file and writes will fails" }
+    { { $link +closed+ } " - the stream is closed; reads will return end of file and writes will fail" }
     { { $link +stdout+ } " - a special value for the " { $snippet "stderr" } " slot only, indicating that the standard output and standard error streams should be merged" }
     { "a path name - the stream is sent to the given file, which must exist for input and is created automatically on output" }
-    { "an " { $link appender } " wrapping a path name - output is sent to the end given file, as with " { $link <file-appender> } }
+    { "an " { $link appender } " wrapping a path name - output is sent to the end of the given file, as with " { $link <file-appender> } }
     { "a file stream or a socket - the stream is connected to the given Factor stream, which cannot be used again from within Factor and must be closed after the process has been started" }
 } ;
 
index 5acb7c6b580026766304ef40133be8a57fb6c82b..fd6ee2a0e29371f85efc8a361a6a7e6965250183 100644 (file)
@@ -7,7 +7,7 @@ HELP: arrow
 { $examples
     "The following code displays a label showing the result of applying " { $link sq } " to the value 5:"
     { $code
-        "USING: models ui.gadgets.labels ui.gadgets.panes ;"
+        "USING: models models.arrow math.parser ui.gadgets.labels ui.gadgets.panes ;"
         "5 <model> [ sq ] <arrow> [ number>string ] <arrow>"
         "<label-control> gadget."
     }
index 03e8a38f93874befe4d6fb9c9127ca672c30a086..478d7c00d6f329c7d3c193e99f70e23a51d4dae5 100644 (file)
@@ -5,7 +5,7 @@ IN: stack-checker
 ARTICLE: "inference-simple" "Straight-line stack effects"
 "The simplest case is when a piece of code does not have any branches or recursion, and just pushes literals and calls words."
 $nl
-"Pushing a literal has stack effect " { $snippet "( -- x )" } ". The stack effect of most words is always known statically from the declaration. Stack effects of " { $link POSTPONE: inline } " words and " { $link "macros" } ", may depend on literals pushed on the stack prior to the call, and this case is discussed in " { $link "inference-combinators" } "."
+"Pushing a literal has stack effect " { $snippet "( -- x )" } ". The stack effect of most words is always known statically from the declaration. Stack effects of " { $link POSTPONE: inline } " words and " { $link "macros" } ", may depend on literals pushed on the stack prior to the call, and this case is discussed in " { $link "inference-combinators" } "."
 $nl
 "The stack effect of each element in a code snippet is composed. The result is then the stack effect of the snippet."
 $nl
index c3a3598c7ac48035fd827261226ee1622900a81c..49905afdc9438bcbec59e995ec9da3ad0574e767 100644 (file)
@@ -2,7 +2,7 @@ USING: help.markup help.syntax calendar quotations system ;
 IN: timers
 
 HELP: timer
-{ $class-description "A timer. Can be passed to " { $link stop-timer } "." } ;
+{ $class-description "A timer. Can be passed to " { $link start-timer } ", " { $link stop-timer } " and " { $link restart-timer } "." } ;
 
 HELP: start-timer
 { $values { "timer" timer } }
index b70705aa720221772dbdb43cd566927ebc5ac15e..35cd8a88fd2953994c7fe961cc4fe1b06e624af1 100644 (file)
@@ -351,7 +351,7 @@ ARTICLE: "keyboard-gestures" "Keyboard gestures"
 }
 "The " { $link S+ } " modifier is only ever used with the above action keys; alphanumeric input input with the shift key is delivered without the " { $link S+ } " modifier set, instead the input itself is upper case. For example, the gesture corresponding to " { $snippet "s" } " with the Control and Shift keys pressed is presented as "
 { $code "T{ key-down f { C+ } \"S\" }" }
-"The " { $snippet "RET" } " and " { $snippet "TAB" } " keys are never delivered in their literal form (" { $snippet "\"\\n\"" } " and " { $snippet "\"\\t\"" } ;
+"The " { $snippet "RET" } " and " { $snippet "TAB" } " keys are never delivered in their literal form (" { $snippet "\"\\n\"" } " and " { $snippet "\"\\t\"" } ")." ;
 
 ARTICLE: "ui-user-input" "Free-form keyboard input"
 "Whereas keyboard gestures are intended to be used for keyboard shortcuts, certain gadgets such as text fields need to accept free-form keyboard input. This can be done by implementing a generic word:"
index 8a8460b2ed0b34ed3a61b30efc953f1e3efe94f5..7a5ccfe37ac51dcd45147c22ff9024eee1183f3f 100644 (file)
@@ -137,7 +137,7 @@ $nl
   }
   {
       { $snippet "\"predicating\"" }
-      " Set on class predicates, stores the corresponding class word"
+      "Set on class predicates, stores the corresponding class word."
   }
   {
       { { $snippet "\"reading\"" } ", " { $snippet "\"writing\"" } }