core/hash-sets/hash-sets-docs.factor

   1 USING: help.markup help.syntax math sequences sets ;
   2 IN: hash-sets
   3
   4 ARTICLE: "hash-sets" "Hash sets"
   5 "The " { $vocab-link "hash-sets" } " vocabulary implements hashtable-like sets. Hash sets form a class:"
   6 { $subsections hash-set }
   7 "Constructing new hash sets:"
   8 { $subsections <hash-set> >hash-set }
   9 "The syntax for hash sets is described in " { $link "syntax-hash-sets" } "." ;
  10
  11 ABOUT: "hash-sets"
  12
  13 HELP: hash-set
  14 { $class-description "The class of hashtable-like sets. These implement the " { $link set } " mixin." } ;
  15
  16 HELP: <hash-set>
  17 { $values { "capacity" number } { "hash-set" hash-set } }
  18 { $description "Creates a new hash set capable of storing " { $snippet "capacity" } " elements before growing." } ;
  19
  20 HELP: >hash-set
  21 { $values { "members" sequence } { "hash-set" hash-set } }
  22 { $description "Creates a new hash set with the given members." } ;