]> gitweb.factorcode.org Git - factor.git/commitdiff
fix a typo in compiler.tree.propagation.constraints documentation
authorCat Stevens <catb0t@protonmail.ch>
Mon, 12 Feb 2018 19:41:41 +0000 (14:41 -0500)
committerJohn Benediktsson <mrjbq7@gmail.com>
Mon, 12 Feb 2018 21:05:27 +0000 (13:05 -0800)
basis/compiler/tree/propagation/constraints/constraints-docs.factor

index afec7bcd0b18e8387e62976f1329571aaf5e3c6f..5e5a921698d001c40e6c314d295f0ecb018ef460 100644 (file)
@@ -17,18 +17,19 @@ HELP: interval-constraint
 { $class-description "An interval constraint." } ;
 
 HELP: literal-constraint
-{ $class-description "A literal constraint" } ;
+{ $class-description "A literal constraint." } ;
 
 HELP: satisfied?
 { $values { "constraint" "a constraint" } { "?" boolean } }
-{ $description "satisfied? is inaccurate. It's just used to prevent infinite loops so its only implemented for true-constraints and false-constraints." } ;
+{ $description "The name " { $snippet "satisfied?" } " is imprecise. This word is used to prevent infinite loops, so it is only implemented for " { $link true-constraint } " and " { $link false-constraint } "." } ;
 
 ARTICLE: "compiler.tree.propagation.constraints" "Support for predicated value info"
-"A constraint is a statement about a value."
+"A constraint is a statement about a value. The " { $vocab-link "compiler.tree.propagation.constraints" } " vocabulary implements these constraints for propagation of values through the compilation process."
 $nl
 "Boolean constraints:"
-{ $subsections true-constraint true-constraint }
+{ $subsections true-constraint false-constraint }
 "Utilities:"
 { $subsections t--> f--> } ;
 
 ABOUT: "compiler.tree.propagation.constraints"
+