extra/tuples/lib/lib-docs.factor

   1 USING: help.syntax help.markup kernel prettyprint sequences ;
   2 IN: tuples.lib
   3
   4 HELP: >tuple<
   5 { $values { "class" "a tuple class" } }
   6 { $description "Explodes the tuple so that tuple slots are on the stack in the order listed in the tuple." }
   7 { $example
   8     "TUPLE: foo a b c ;"
   9     "1 2 3 \\ foo construct-boa \\ foo >tuple< .s"
  10     "1\n2\n3"
  11 }
  12 { $notes "Words using " { $snippet ">tuple<" } " may be compiled." }
  13 { $see-also >tuple*< } ;
  14
  15 HELP: >tuple*<
  16 { $values { "class" "a tuple class" } }
  17 { $description "Explodes the tuple so that tuple slots ending with '*' are on the stack in the order listed in the tuple." }
  18 { $example
  19     "TUPLE: foo a bb* ccc dddd* ;"
  20     "1 2 3 4 \\ foo construct-boa \\ foo >tuple*< .s"
  21     "2\n4"
  22 }
  23 { $notes "Words using " { $snippet ">tuple*<" } " may be compiled." }
  24 { $see-also >tuple< } ;
  25