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

Improve " docs

db4
Slava Pestov 2009-02-17 14:26:25 -06:00
parent 92158ef055
commit 664e9b75de
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
core/syntax/syntax-docs.factor
View 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... \"" }