basis/qualified/qualified-docs.factor

   1 USING: help.markup help.syntax ;
   2 IN: qualified
   3
   4 HELP: QUALIFIED:
   5 { $syntax "QUALIFIED: vocab" }
   6 { $description "Similar to " { $link POSTPONE: USE: } " but loads vocabulary with prefix." }
   7 { $examples { $code
   8     "QUALIFIED: math\n1 2 math:+ ! ==> 3" } } ;
   9
  10 HELP: QUALIFIED-WITH:
  11 { $syntax "QUALIFIED-WITH: vocab word-prefix" }
  12 { $description "Works like " { $link POSTPONE: QUALIFIED: } " but uses " { $snippet "word-prefix" } " as prefix." }
  13 { $examples { $code
  14     "QUALIFIED-WITH: math m\n1 2 m:+ ! ==> 3" } } ;
  15
  16 HELP: FROM:
  17 { $syntax "FROM: vocab => words ... ;" }
  18 { $description "Imports " { $snippet "words" } " from " { $snippet "vocab" } "." }
  19 { $examples { $code
  20     "FROM: math.parser => bin> hex> ; ! imports only bin> and hex>" } } ;
  21
  22 HELP: EXCLUDE:
  23 { $syntax "EXCLUDE: vocab => words ... ;" }
  24 { $description "Imports everything from " { $snippet "vocab" } " excluding " { $snippet "words" } "." }
  25 { $examples { $code
  26     "EXCLUDE: math.parser => bin> hex> ; ! imports everything but bin> and hex>" } } ;
  27
  28 HELP: RENAME:
  29 { $syntax "RENAME: word vocab => newname " }
  30 { $description "Imports " { $snippet "word" } " from " { $snippet "vocab" } ", but renamed to " { $snippet "newname" } "." }
  31 { $examples { $code
  32     "RENAME: + math => -"
  33     "2 3 - ! => 5" } } ;
  34