factor/core/classes/predicate/predicate-docs.factor

USING: generic help.markup help.syntax kernel kernel.private
namespaces sequences words arrays layouts help effects math
classes.private classes compiler.units ;
IN: classes.predicate

ARTICLE: "predicates" "Predicate classes"
"Predicate classes allow fine-grained control over method dispatch."
{ $subsections
    \ \PREDICATE:
    define-predicate-class
}
"The set of predicate classes is a class:"
{ $subsections
    predicate-class
    predicate-class?
} ;

ABOUT: "predicates"

HELP: define-predicate-class
{ $values { "class" class } { "superclass" class } { "definition" { $quotation ( superclass -- ? ) } } }
{ $description "Defines a predicate class. This is the run time equivalent of " { $link \ \PREDICATE: } "." }
{ $notes "This word must be called from inside " { $link with-compilation-unit } "." }
{ $side-effects "class" } ;

{ predicate-class define-predicate-class \ \PREDICATE: } related-words

HELP: predicate-class
{ $class-description "The class of predicate class words, defined by " { $link \ \PREDICATE: } " and documented in " { $link "predicates" } "." } ;