steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation updates

db4
Slava Pestov 2009-04-14 17:55:58 -05:00
parent f850ba5665
commit 128715def4
4 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
basis/help/handbook/handbook.factor
View File

@ -253,12 +253,12 @@ ARTICLE: "handbook-language-reference" "Language reference"
{ $subsection "conventions" } { $subsection "conventions" }
{ $subsection "syntax" } { $subsection "syntax" }
{ $subsection "effects" } { $subsection "effects" }
{ $subsection "evaluator" }
"Data types:" "Data types:"
{ $subsection "booleans" } { $subsection "booleans" }
{ $subsection "numbers" } { $subsection "numbers" }
{ $subsection "collections" } { $subsection "collections" }
"Evaluation semantics:" "Evaluation:"
{ $subsection "evaluator" }
{ $subsection "words" } { $subsection "words" }
{ $subsection "shuffle-words" } { $subsection "shuffle-words" }
{ $subsection "combinators" } { $subsection "combinators" }

1
core/quotations/quotations-docs.factor
View File

@ -24,6 +24,7 @@ ARTICLE: "wrappers" "Wrappers"
"Wrappers are used to push words on the data stack; they evaluate to the object being wrapped:" "Wrappers are used to push words on the data stack; they evaluate to the object being wrapped:"
{ $subsection wrapper } { $subsection wrapper }
{ $subsection literalize } { $subsection literalize }
"Wrapper literal syntax is documented in " { $link "syntax-words" } "."
{ $see-also "combinators" } ; { $see-also "combinators" } ;
ABOUT: "quotations" ABOUT: "quotations"

12
core/words/constant/constant-docs.factor Normal file
View File

@ -0,0 +1,12 @@
USING: help.markup help.syntax words.constant ;
IN: words.constant
ARTICLE: "words.constant" "Constants"
"There is a syntax for defining words which push literals on the stack."
$nl
"Define a new word that pushes a literal on the stack:"
{ $subsection POSTPONE: CONSTANT: }
"Define an constant at run-time:"
{ $subsection define-constant } ;
ABOUT: "words.constant"

3
core/words/words-docs.factor
View File

@ -31,7 +31,7 @@ $nl
{ $subsection define } { $subsection define }
{ $subsection define-declared } { $subsection define-declared }
{ $subsection define-inline } { $subsection define-inline }
"Word definitions should declare their stack effect, unless the definition is completely trivial. See " { $link "effect-declaration" } "." "Word definitions must declare their stack effect. See " { $link "effect-declaration" } "."
$nl $nl
"All other types of word definitions, such as " { $link "words.symbol" } " and " { $link "generic" } ", are just special cases of the above." ; "All other types of word definitions, such as " { $link "words.symbol" } " and " { $link "generic" } ", are just special cases of the above." ;
@ -75,6 +75,7 @@ ARTICLE: "word-definition" "Defining words"
{ $subsection "colon-definition" } { $subsection "colon-definition" }
{ $subsection "words.symbol" } { $subsection "words.symbol" }
{ $subsection "words.alias" } { $subsection "words.alias" }
{ $subsection "words.constant" }
{ $subsection "primitives" } { $subsection "primitives" }
{ $subsection "deferred" } { $subsection "deferred" }
{ $subsection "declarations" } { $subsection "declarations" }