]> gitweb.factorcode.org Git - factor.git/commitdiff
Improve " docs
authorSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Tue, 17 Feb 2009 20:26:25 +0000 (14:26 -0600)
committerSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Tue, 17 Feb 2009 20:26:25 +0000 (14:26 -0600)
core/syntax/syntax-docs.factor

index 035622454f62d7127218a470dafe0e0d220c8016..31b8516675200e7303e93d37fe663c56f18b5111 100644 (file)
@@ -485,8 +485,13 @@ HELP: CHAR:
 HELP: "
 { $syntax "\"string...\"" }
 { $values { "string" "literal and escaped characters" } }
-{ $description "Reads from the input string until the next occurrence of " { $link POSTPONE: " } ", and appends the resulting string to the parse tree. String literals cannot span multiple lines. Strings containing the " { $link POSTPONE: " } " character and various other special characters can be read by inserting escape sequences." }
-{ $examples { $example "USE: io" "\"Hello\\nworld\" print" "Hello\nworld" } } ;
+{ $description "Reads from the input string until the next occurrence of " { $link POSTPONE: " } ", and appends the resulting string to the parse tree. String literals cannot span multiple lines. Strings containing the " { $link POSTPONE: " } " character and various other special characters can be read by inserting " { $link "escape" } "." }
+{ $examples
+  "A string with a newline in it:"
+  { $example "USE: io" "\"Hello\\nworld\" print" "Hello\nworld" }
+  "A string with a named Unicode code point:"
+  { $example "USE: io" "\"\\u{greek-capital-letter-sigma}\" print" "\u{greek-capital-letter-sigma}" }
+} ;
 
 HELP: SBUF"
 { $syntax "SBUF\" string... \"" }