]> gitweb.factorcode.org Git - factor.git/commitdiff
Better values docs
authorSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Thu, 20 Nov 2008 01:43:11 +0000 (19:43 -0600)
committerSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Thu, 20 Nov 2008 01:43:11 +0000 (19:43 -0600)
basis/values/values-docs.factor

index 69e2801110c81deb5fd3d2601b20f6f6f37919aa..866af469e94357c84f46e2190df3e2fef30a1a98 100644 (file)
@@ -2,7 +2,7 @@ USING: help.markup help.syntax ;
 IN: values\r
 \r
 ARTICLE: "values" "Global values"\r
-"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:"\r
+"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:"\r
 { $subsection POSTPONE: VALUE: }\r
 "To get the value, just call the word. The following words manipulate values:"\r
 { $subsection get-value }\r
@@ -10,6 +10,8 @@ ARTICLE: "values" "Global values"
 { $subsection POSTPONE: to: }\r
 { $subsection change-value } ;\r
 \r
+ABOUT: "values"\r
+\r
 HELP: VALUE:\r
 { $syntax "VALUE: word" }\r
 { $values { "word" "a word to be created" } }\r