docs: minor fixes and amendments.
parent
59e3cf93b7
commit
1e0bf40b7f
|
@ -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" }
|
||||
} ;
|
||||
|
||||
|
|
|
@ -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."
|
||||
}
|
||||
|
|
|
@ -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 a 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
|
||||
|
|
|
@ -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 } }
|
||||
|
|
|
@ -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:"
|
||||
|
|
|
@ -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\"" } }
|
||||
|
|
Loading…
Reference in New Issue