core/classes/predicate/predicate-docs.factor

   1 USING: generic help.markup help.syntax kernel kernel.private
   2 namespaces sequences words arrays layouts help effects math
   3 layouts classes.private classes compiler.units ;
   4 IN: classes.predicate
   5
   6 ARTICLE: "predicates" "Predicate classes"
   7 "Predicate classes allow fine-grained control over method dispatch."
   8 { $subsection POSTPONE: PREDICATE: }
   9 { $subsection define-predicate-class }
  10 "The set of predicate classes is a class:"
  11 { $subsection predicate-class }
  12 { $subsection predicate-class? } ;
  13
  14 ABOUT: "predicates"
  15
  16 HELP: define-predicate-class
  17 { $values { "class" class } { "superclass" class } { "definition" "a quotation with stack effect " { $snippet "( superclass -- ? )" } } }
  18 { $description "Defines a predicate class. This is the run time equivalent of " { $link POSTPONE: PREDICATE: } "." }
  19 { $notes "This word must be called from inside " { $link with-compilation-unit } "." }
  20 { $side-effects "class" } ;
  21
  22 { predicate-class define-predicate-class POSTPONE: PREDICATE: } related-words
  23
  24 HELP: predicate-class
  25 { $class-description "The class of predicate class words, defined by " { $link POSTPONE: PREDICATE: } " and documented in " { $link "predicates" } "." } ;