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

link vocabularies->words->quotations in synopsis documentation

db4
Joe Groff 2009-10-28 22:48:25 -05:00
parent c318530bbd
commit 2599993093
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
core/vocabs/vocabs-docs.factor
View File

@ -2,7 +2,7 @@ USING: help.markup help.syntax strings words compiler.units ;
IN: vocabs
ARTICLE: "vocabularies" "Vocabularies"
"A " { $emphasis "vocabulary" } " is a named collection of words. Vocabularies are defined in the " { $vocab-link "vocabs" } " vocabulary."
"A " { $emphasis "vocabulary" } " is a named collection of " { $link "words" } ". Vocabularies are defined in the " { $vocab-link "vocabs" } " vocabulary."
$nl
"Vocabularies are stored in a global hashtable:"
{ $subsections dictionary }
@ -108,4 +108,4 @@ HELP: >vocab-link
{ $description "If the vocabulary is loaded, outputs the corresponding " { $link vocab } " instance, otherwise creates a new " { $link vocab-link } "." } ;
HELP: runnable-vocab
{ $class-description "The class of vocabularies with a " { $slot "main" } " word." } ;
{ $class-description "The class of vocabularies with a " { $slot "main" } " word." } ;

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

@ -26,7 +26,7 @@ $nl
} ;
ARTICLE: "colon-definition" "Colon definitions"
"Every word has an associated quotation definition that is called when the word is executed. A " { $emphasis "colon definition" } " is a word where this quotation is supplied directly by the user. This is the simplest and most common type of word definition."
"All words have associated definition " { $link "quotations" } ". A word's definition quotation is called when the word is executed. A " { $emphasis "colon definition" } " is a word where this quotation is supplied directly by the user. This is the simplest and most common type of word definition."
$nl
"Defining words at parse time:"
{ $subsections
@ -160,7 +160,7 @@ $nl
} ;
ARTICLE: "words" "Words"
"Words are the Factor equivalent of functions or procedures; a word is essentially a named quotation."
"Words are the Factor equivalent of functions or procedures in other languages. Words are essentially named " { $link "quotations" } "."
$nl
"There are two ways of creating word definitions:"
{ $list