unmaintained/isequences/interface/interface-docs.factor

   1 USING: help.markup help.syntax isequences.interface ;
   2
   3 HELP: i-at
   4 { $values { "s" "an isequence" } { "n" "an isequence" } { "v" "the element at the " { $snippet "n" } "th index" } }
   5 { $contract "Outputs the element at position" { $snippet "n" } "of the isequence." } ;
   6
   7 HELP: --
   8 { $values { "s" "an isequence" } { "-s" "a negated isequence" } }
   9 { $contract "Outputs the negated version of " { $snippet "s"} " with its length and indices negated." } ;
  10
  11 HELP: i-length
  12 { $values { "s" "an isequence" } { "n" "an integer length" } }
  13 { $contract "Outputs the length of " { $snippet "s" } " which can be negative for a negated isequence." } ;
  14
  15 HELP: ++
  16 { $values { "s1" "an isequence" } { "s2" "an isequence" } { "s" "the concatenated result of " { $snippet "s1" } " and " { $snippet "s2" } } }
  17 { $contract "Outputs the freshly concatened isequence with length = length(s1) + length(s2)." } ;