core/strings/parser/parser-docs.factor

   1 USING: help.markup help.syntax strings ;
   2 IN: strings.parser
   3
   4 HELP: bad-escape
   5 { $error-description "Indicates the parser encountered an invalid escape code following a backslash (" { $snippet "\\" } ") in a string literal. See " { $link "escape" } " for a list of valid escape codes." } ;
   6
   7 HELP: escape
   8 { $values { "escape" "a single-character escape" } { "ch" "a character" } }
   9 { $description "Converts from a single-character escape code and the corresponding character." }
  10 { $examples { $example "USING: kernel prettyprint strings.parser ;" "CHAR: n escape CHAR: \\n = ." "t" } } ;
  11
  12 HELP: parse-string
  13 { $values { "str" "a new " { $link string } } }
  14 { $description "Parses one or more lines until a quote (\"), interpreting escape codes along the way." }
  15 { $errors "Throws an error if the string contains an invalid escape sequence." }
  16 $parsing-note ;