From 338e99e4343f12b7751428e29902c96dc6ca76c4 Mon Sep 17 00:00:00 2001 From: John Benediktsson Date: Sun, 19 Apr 2015 20:47:05 -0700 Subject: [PATCH] peg: remove trailing whitespace from docs. --- basis/peg/peg-docs.factor | 114 +++++++++++++++++++------------------- 1 file changed, 57 insertions(+), 57 deletions(-) diff --git a/basis/peg/peg-docs.factor b/basis/peg/peg-docs.factor index 761c66fdee..c90b9cc258 100644 --- a/basis/peg/peg-docs.factor +++ b/basis/peg/peg-docs.factor @@ -4,32 +4,32 @@ USING: help.markup help.syntax kernel quotations strings words ; IN: peg HELP: parse -{ $values +{ $values { "input" string } { "parser" parser } { "ast" object } } -{ $description +{ $description "Given the input string, parse it using the given parser. The result is the abstract " - "syntax tree returned by the parser." } + "syntax tree returned by the parser." } { $see-also compile } ; HELP: compile -{ $values +{ $values { "parser" parser } { "word" word } } -{ $description +{ $description "Compile the parser to a word. The word will have stack effect ( -- ast )." -} +} { $see-also parse } ; HELP: token -{ $values +{ $values { "string" string } { "parser" parser } } -{ $description +{ $description "Returns a parser that matches the given string." } ; HELP: satisfy @@ -37,7 +37,7 @@ HELP: satisfy { "quot" quotation } { "parser" parser } } -{ $description +{ $description "Returns a parser that calls the quotation on the first character of the input string, " "succeeding if that quotation returns true. The AST is the character from the string." } ; @@ -56,83 +56,83 @@ HELP: seq { "seq" "a sequence of parsers" } { "parser" parser } } -{ $description +{ $description "Returns a parser that calls all parsers in the given sequence, in order. The parser succeeds if " "all the parsers succeed, otherwise it fails. The AST produced is a sequence of the AST produced by " "the individual parsers." } ; HELP: choice -{ $values - { "seq" "a sequence of parsers" } - { "parser" parser } +{ $values + { "seq" "a sequence of parsers" } + { "parser" parser } } -{ $description +{ $description "Returns a parser that will try all the parsers in the sequence, in order, until one succeeds. " "The resulting AST is that produced by the successful parser." } ; HELP: repeat0 -{ $values - { "parser" parser } +{ $values + { "parser" parser } } -{ $description +{ $description "Returns a parser that parses 0 or more instances of the 'p1' parser. The AST produced is " "an array of the AST produced by the 'p1' parser. An empty array indicates 0 instances were " "parsed." } ; HELP: repeat1 -{ $values - { "parser" parser } +{ $values + { "parser" parser } } -{ $description +{ $description "Returns a parser that parses 1 or more instances of the 'p1' parser. The AST produced is " "an array of the AST produced by the 'p1' parser." } ; HELP: optional -{ $values - { "parser" parser } +{ $values + { "parser" parser } } -{ $description +{ $description "Returns a parser that parses 0 or 1 instances of the 'p1' parser. The AST produced is " "'f' if 0 instances are parsed the AST produced is 'f', otherwise it is the AST produced by 'p1'." } ; HELP: semantic -{ $values - { "parser" parser } - { "quot" { $quotation ( object -- ? ) } } +{ $values + { "parser" parser } + { "quot" { $quotation ( object -- ? ) } } } -{ $description +{ $description "Returns a parser that succeeds if the 'p1' parser succeeds and the quotation called with " "the AST produced by 'p1' on the stack returns true." } -{ $examples - { $example "USING: kernel math peg prettyprint ;" "\"C\" [ drop t ] satisfy [ 66 > ] semantic parse ." "67" } +{ $examples + { $example "USING: kernel math peg prettyprint ;" "\"C\" [ drop t ] satisfy [ 66 > ] semantic parse ." "67" } } ; HELP: ensure -{ $values - { "parser" parser } +{ $values + { "parser" parser } } -{ $description +{ $description "Returns a parser that succeeds if the 'p1' parser succeeds but does not add anything to the " "AST and does not move the location in the input string. This can be used for lookahead and " "disambiguation, along with the " { $link ensure-not } " word." } { $examples { $code "\"0\" token ensure octal-parser" } } ; HELP: ensure-not -{ $values - { "parser" parser } +{ $values + { "parser" parser } } -{ $description +{ $description "Returns a parser that succeeds if the 'p1' parser fails but does not add anything to the " "AST and does not move the location in the input string. This can be used for lookahead and " "disambiguation, along with the " { $link ensure } " word." } { $code "\"+\" token \"=\" token ensure-not \"+=\" token 3array seq" } ; HELP: action -{ $values - { "parser" parser } - { "quot" { $quotation ( ast -- ast ) } } +{ $values + { "parser" parser } + { "quot" { $quotation ( ast -- ast ) } } } -{ $description +{ $description "Returns a parser that calls the 'p1' parser and applies the quotation to the AST resulting " "from that parse. The result of the quotation is then used as the final AST. This can be used " "for manipulating the parse tree to produce a AST better suited for the task at hand rather than " @@ -140,41 +140,41 @@ HELP: action { $code "CHAR: 0 CHAR: 9 range [ to-digit ] action" } ; HELP: sp -{ $values - { "parser" parser } +{ $values + { "parser" parser } } -{ $description +{ $description "Returns a parser that calls the original parser 'p1' after stripping any whitespace " " from the left of the input string." } ; HELP: hide -{ $values - { "parser" parser } +{ $values + { "parser" parser } } -{ $description - "Returns a parser that succeeds if the original parser succeeds, but does not " +{ $description + "Returns a parser that succeeds if the original parser succeeds, but does not " "put any result in the AST. Useful for ignoring 'syntax' in the AST." } { $code "\"[\" token hide number \"]\" token hide 3array seq" } ; HELP: delay -{ $values - { "quot" quotation } - { "parser" parser } +{ $values + { "quot" quotation } + { "parser" parser } } -{ $description - "Delays the construction of a parser until it is actually required to parse. This " +{ $description + "Delays the construction of a parser until it is actually required to parse. This " "allows for calling a parser that results in a recursive call to itself. The quotation " - "should return the constructed parser and is called the first time the parser is run." + "should return the constructed parser and is called the first time the parser is run. " "The compiled result is memoized for future runs. See " { $link box } " for a word " "that calls the quotation at compile time." } ; HELP: box -{ $values - { "quot" quotation } - { "parser" parser } +{ $values + { "quot" quotation } + { "parser" parser } } -{ $description +{ $description "Delays the construction of a parser until the parser is compiled. The quotation " - "should return the constructed parser and is called when the parser is compiled." + "should return the constructed parser and is called when the parser is compiled. " "The compiled result is memoized for future runs. See " { $link delay } " for a word " "that calls the quotation at runtime." } ;