]> gitweb.factorcode.org Git - factor.git/commitdiff
literals: fix formatting and example error in docs
authorKeita Haga <keitahaga@mail.com>
Sun, 5 Dec 2010 20:06:15 +0000 (05:06 +0900)
committerKeita Haga <keitahaga@mail.com>
Sun, 5 Dec 2010 20:06:15 +0000 (05:06 +0900)
basis/literals/literals-docs.factor

index 6fcf8a5e07c807970d6b510e9fef5704f0c68384..52aa1cd717742fc0c3b614bd0a75d01047488163 100644 (file)
@@ -8,23 +8,22 @@ HELP: $
 { $description "Executes " { $snippet "word" } " at parse time and adds the result(s) to the parser accumulator." }
 { $notes { $snippet "word" } "'s definition is looked up and " { $link call } "ed at parse time, so words that reference words in the current compilation unit cannot be used with " { $snippet "$" } "." }
 { $examples
-
-    { $example """
-USING: kernel literals prettyprint ;
-IN: scratchpad
-
-CONSTANT: five 5
-{ $ five } .
-    """ "{ 5 }" }
-
-    { $example """
-USING: kernel literals prettyprint ;
-IN: scratchpad
-
-: seven-eleven ( -- a b ) 7 11 ;
-{ $ seven-eleven } .
-    """ "{ 7 11 }" }
-
+    { $example
+        "USING: kernel literals prettyprint ;"
+        "IN: scratchpad"
+        ""
+        "CONSTANT: five 5"
+        "{ $ five } ."
+        "{ 5 }"
+    }
+    { $example
+        "USING: kernel literals prettyprint ;"
+        "IN: scratchpad"
+        ""
+        ": seven-eleven ( -- a b ) 7 11 ;"
+        "{ $ seven-eleven } ."
+        "{ 7 11 }"
+    }
 } ;
 
 HELP: $[
@@ -32,15 +31,14 @@ HELP: $[
 { $description "Calls " { $snippet "code" } " at parse time and adds the result(s) to the parser accumulator." }
 { $notes "Since " { $snippet "code" } " is " { $link call } "ed at parse time, it cannot reference any words defined in the same compilation unit." }
 { $examples
-
-    { $example """
-USING: kernel literals math prettyprint ;
-IN: scratchpad
-
-<< CONSTANT: five 5 >>
-{ $[ five dup 1 + dup 2 + ] } .
-    """ "{ 5 6 8 }" }
-
+    { $example
+        "USING: kernel literals math prettyprint ;"
+        "IN: scratchpad"
+        ""
+        "<< CONSTANT: five 5 >>"
+        "{ $[ five dup 1 + dup 2 + ] } ."
+        "{ 5 6 8 }"
+    }
 } ;
 
 HELP: ${
@@ -48,15 +46,14 @@ HELP: ${
 { $description "Outputs an array containing the results of executing " { $snippet "code" } " at parse time." }
 { $notes { $snippet "code" } "'s definition is looked up and " { $link call } "ed at parse time, so words that reference words in the current compilation unit cannot be used with " { $snippet "$" } "." }
 { $examples
-
-    { $example """
-USING: kernel literals math prettyprint ;
-IN: scratchpad
-
-CONSTANT: five 5
-CONSTANT: six 6
-${ five six 7 } .
-    """ "{ 5 6 7 }"
+    { $example
+        "USING: kernel literals math prettyprint ;"
+        "IN: scratchpad"
+        ""
+        "CONSTANT: five 5"
+        "CONSTANT: six 6"
+        "${ five six 7 } ."
+        "{ 5 6 7 }"
     }
 } ;
 
@@ -66,7 +63,8 @@ HELP: flags{
 { $values { "values" sequence } }
 { $description "Constructs a constant flag value from a sequence of integers or words that output integers. The resulting constant is computed at parse-time, which makes this word as efficient as using a literal integer." }
 { $examples
-    { $example "USING: literals kernel prettyprint ;"
+    { $example
+        "USING: literals kernel prettyprint ;"
         "IN: scratchpad"
         "CONSTANT: x HEX: 1"
         "flags{ HEX: 20 x BIN: 100 } .h"
@@ -77,13 +75,14 @@ HELP: flags{
 
 ARTICLE: "literals" "Interpolating code results into literal values"
 "The " { $vocab-link "literals" } " vocabulary contains words to run code at parse time and insert the results into more complex literal values."
-{ $example """
-USE: literals
-IN: scratchpad
-
-CONSTANT: five 5
-{ $ five $[ five dup 1 + dup 2 + ] } .
-    """ "{ 5 5 6 8 }" }
+{ $example
+    "USING: kernel literals math prettyprint ;"
+    "IN: scratchpad"
+    ""
+    "<< CONSTANT: five 5 >>"
+    "{ $ five $[ five dup 1 + dup 2 + ] } ."
+    "{ 5 5 6 8 }"
+}
 { $subsections
     POSTPONE: $
     POSTPONE: $[