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

Better values docs

db4
Slava Pestov 2008-11-19 19:43:11 -06:00
parent 3d8f432856
commit d6264a32ce
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
basis/values/values-docs.factor
View File

@ -2,7 +2,7 @@ USING: help.markup help.syntax ;
IN: values IN: values
ARTICLE: "values" "Global values" ARTICLE: "values" "Global values"
"Usually, dynamically scoped variables are sufficient for holding data which is not literal. But occasionally, for global information that's calculated just once, it's useful to use the word mechanism instead, and set the word to the appropriate value just once. Values abstract over this concept. To create a new word as a value, use the following syntax:" "Usually, dynamically scoped variables are sufficient for holding data which is not literal. But occasionally, for global information that's calculated just once, it's useful to use the word mechanism instead, and set the word to the appropriate value just once. The " { $vocab-link "values" } " vocabulary implements " { $emphasis "values" } ", which abstract over this concept. To create a new word as a value, use the following syntax:"
{ $subsection POSTPONE: VALUE: } { $subsection POSTPONE: VALUE: }
"To get the value, just call the word. The following words manipulate values:" "To get the value, just call the word. The following words manipulate values:"
{ $subsection get-value } { $subsection get-value }
@ -10,6 +10,8 @@ ARTICLE: "values" "Global values"
{ $subsection POSTPONE: to: } { $subsection POSTPONE: to: }
{ $subsection change-value } ; { $subsection change-value } ;
ABOUT: "values"
HELP: VALUE: HELP: VALUE:
{ $syntax "VALUE: word" } { $syntax "VALUE: word" }
{ $values { "word" "a word to be created" } } { $values { "word" "a word to be created" } }