From 738113d52448b9854a75deb8ee2f17049495d61f Mon Sep 17 00:00:00 2001 From: John Benediktsson Date: Thu, 24 Oct 2019 14:10:41 -0700 Subject: [PATCH] classes: update docs with $sequence. --- core/classes/algebra/algebra-docs.factor | 6 +++--- core/classes/classes-docs.factor | 6 +++--- core/classes/intersection/intersection-docs.factor | 2 +- core/classes/tuple/tuple-docs.factor | 4 ++-- core/classes/union/union-docs.factor | 4 ++-- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/core/classes/algebra/algebra-docs.factor b/core/classes/algebra/algebra-docs.factor index 747bbf6d0d..76c7c70bbf 100644 --- a/core/classes/algebra/algebra-docs.factor +++ b/core/classes/algebra/algebra-docs.factor @@ -41,11 +41,11 @@ $nl { $subsections rank-class } ; HELP: flatten-class -{ $values { "class" class } { "assoc" "an assoc whose keys are classes" } } +{ $values { "class" class } { "seq" { $sequence class } } } { $description "Outputs a set of builtin and tuple classes whose union is the smallest cover of " { $snippet "class" } "." } ; HELP: class<= -{ $values { "first" "a class" } { "second" "a class" } { "?" boolean } } +{ $values { "first" class } { "second" class } { "?" boolean } } { $description "Tests if all instances of " { $snippet "class1" } " are also instances of " { $snippet "class2" } "." } { $notes "Classes are partially ordered. This means that if " { $snippet "class1 <= class2" } " and " { $snippet "class2 <= class1" } ", then " { $snippet "class1 <= class2" } ". Also, if " { $snippet "class1 <= class2" } " and " { $snippet "class2 <= class3" } ", then " { $snippet "class1 <= class3" } "." } ; @@ -74,5 +74,5 @@ HELP: smallest-class { $description "Outputs a minimum class from the given sequence." } ; HELP: sort-classes -{ $values { "seq" "a sequence of class" } { "newseq" "a new sequence of classes" } } +{ $values { "seq" { $sequence class } } { "newseq" { $sequence class } } } { $description "Outputs a linear sort of a sequence of classes. Larger classes come before their subclasses." } ; diff --git a/core/classes/classes-docs.factor b/core/classes/classes-docs.factor index bc75d45f42..e88ab89c34 100644 --- a/core/classes/classes-docs.factor +++ b/core/classes/classes-docs.factor @@ -87,7 +87,7 @@ HELP: class-usage { $description "Lists all classes that uses or depends on this class." } ; HELP: classes -{ $values { "seq" "a sequence of class words" } } +{ $values { "seq" { $sequence class } } } { $description "Finds all class words in the dictionary." } ; HELP: contained-classes @@ -166,12 +166,12 @@ HELP: class-participants { $description "If " { $snippet "class" } " is an intersection class, outputs a sequence of its participant classes, otherwise outputs " { $link f } "." } ; HELP: define-class -{ $values { "word" word } { "superclass" class } { "members" "a sequence of class words" } { "participants" "a sequence of class words" } { "metaclass" class } } +{ $values { "word" word } { "superclass" class } { "members" { $sequence class } } { "participants" { $sequence class } } { "metaclass" class } } { $description "Sets a property indicating this word is a class word, thus making it an instance of " { $link class } ", and registers it with " { $link update-map } "." } $low-level-note ; HELP: implementors -{ $values { "class/classes" "a class or a sequence of classes" } { "seq" "a sequence of generic words" } } +{ $values { "class/classes" { $or class { $sequence class } } } { "seq" "a sequence of generic words" } } { $description "Finds all generic words in the dictionary implementing methods for the given set of classes." } ; HELP: instance? diff --git a/core/classes/intersection/intersection-docs.factor b/core/classes/intersection/intersection-docs.factor index 7b20621e4c..3c8b3f7293 100644 --- a/core/classes/intersection/intersection-docs.factor +++ b/core/classes/intersection/intersection-docs.factor @@ -19,7 +19,7 @@ ARTICLE: "intersections" "Intersection classes" ABOUT: "intersections" HELP: define-intersection-class -{ $values { "class" class } { "participants" "a sequence of classes" } } +{ $values { "class" class } { "participants" { $sequence class } } } { $description "Defines a intersection class with specified participants. This is the run time equivalent of " { $link POSTPONE: INTERSECTION: } "." } { $notes "This word must be called from inside " { $link with-compilation-unit } "." } { $side-effects "class" } ; diff --git a/core/classes/tuple/tuple-docs.factor b/core/classes/tuple/tuple-docs.factor index b1d20a04d6..b3ae92dbd5 100644 --- a/core/classes/tuple/tuple-docs.factor +++ b/core/classes/tuple/tuple-docs.factor @@ -373,7 +373,7 @@ HELP: define-tuple-predicate $low-level-note ; HELP: redefine-tuple-class -{ $values { "class" class } { "superclass" class } { "slots" "a sequence of strings" } } +{ $values { "class" class } { "superclass" class } { "slots" { $sequence string } } } { $description "If the new slot layout differs from the existing one, updates all existing instances of this tuple class, and forgets any slot accessor words which are no longer needed." $nl "If the class is not a tuple class word, this word does nothing." } @@ -396,7 +396,7 @@ HELP: check-tuple { $error-description "Thrown if " { $link POSTPONE: C: } " is called with a word which does not name a tuple class." } ; HELP: define-tuple-class -{ $values { "class" word } { "superclass" class } { "slots" "a sequence of strings" } } +{ $values { "class" word } { "superclass" class } { "slots" { $sequence string } } } { $description "Defines a tuple class inheriting from " { $snippet "superclass" } " with slots named by " { $snippet "slots" } ". This is the run time equivalent of " { $link POSTPONE: TUPLE: } "." } { $notes "This word must be called from inside " { $link with-compilation-unit } "." } { $side-effects "class" } ; diff --git a/core/classes/union/union-docs.factor b/core/classes/union/union-docs.factor index 2335151e58..911fa2e2c4 100644 --- a/core/classes/union/union-docs.factor +++ b/core/classes/union/union-docs.factor @@ -21,12 +21,12 @@ ARTICLE: "unions" "Union classes" ABOUT: "unions" HELP: (define-union-class) -{ $values { "class" class } { "members" "a sequence of classes" } } +{ $values { "class" class } { "members" { $sequence class } } } { $description "Defines a union class." } { $errors "Throws " { $link cannot-reference-self } " if the definition references itself." } ; HELP: define-union-class -{ $values { "class" class } { "members" "a sequence of classes" } } +{ $values { "class" class } { "members" { $sequence class } } } { $description "Defines a union class with specified members. This is the run time equivalent of " { $link POSTPONE: UNION: } "." } { $notes "This word must be called from inside " { $link with-compilation-unit } "." } { $side-effects "class"