core/locals/parser/parser-docs.factor

   1 USING: help.markup help.syntax locals.types quotations strings
   2 vocabs.parser ;
   3 IN: locals.parser
   4
   5 HELP: in-lambda?
   6 { $var-description { $link t } " if we're currently parsing a lambda with lexical variables." } ;
   7
   8 HELP: parse-def
   9 { $values
  10   { "name/paren" string }
  11   { "def" multi-def }
  12 }
  13 { $description "Parses the lexical variable bindings following a " { $link POSTPONE: :> } " token." } ;
  14
  15 HELP: with-lambda-scope
  16 { $values { "assoc" "local variables" } { "reader-quot" quotation } { "quot" quotation } }
  17 { $description "Runs the quotation in a lambda scope. That means that any local variables are available for lookup in the " { $link manifest } ", but are cleaned up after the quotation finishes." } ;
  18
  19 ARTICLE: "locals.parser" "Utility words used by locals parsing words"
  20 "Words for parsing local words."
  21 $nl
  22 "Words for parsing variable assignments:"
  23 { $subsections parse-def parse-multi-def parse-single-def }
  24 "Parsers for word and method definitions:"
  25 { $subsections (::) (M::) } ;
  26
  27 ABOUT: "locals.parser"