extra/tuple-arrays/tuple-arrays-docs.factor

   1 USING: help.syntax help.markup splitting kernel ;
   2 IN: tuple-arrays
   3
   4 HELP: tuple-array
   5 { $description "The class of packed homogeneous tuple arrays. They are created with " { $link <tuple-array> } ". All elements are of the same tuple class. Mutations done to an element are not copied back to the packed array unless it is explicitly written back.." } ;
   6
   7 HELP: <tuple-array>
   8 { $values { "example" tuple } { "length" "a non-negative integer" } { "tuple-array" tuple-array } }
   9 { $description "Creates an instance of the " { $link <tuple-array> } " class with the given length and containing the given tuple class. The tuple class is specified in the form of an example tuple. If the example tuple has a delegate, the tuple array will store a delegate for each element. Otherwise, the delegate will be assumed to be " { $link f } "." } ;