]> gitweb.factorcode.org Git - factor.git/commitdiff
wrap.words: fix docs
authorDoug Coleman <doug.coleman@gmail.com>
Mon, 20 Jul 2015 08:31:10 +0000 (01:31 -0700)
committerDoug Coleman <doug.coleman@gmail.com>
Mon, 20 Jul 2015 08:31:10 +0000 (01:31 -0700)
basis/wrap/words/words-docs.factor

index 66d0a30fba1c37846030ffa11d5e76cfe195823a..e3a77e127a0ed1f73d776f1b41623bf60b93994b 100644 (file)
@@ -9,19 +9,19 @@ ARTICLE: "wrap.words" "Word object wrapping"
 "The " { $vocab-link "wrap.words" } " vocabulary implements word wrapping on abstract word objects, which have certain properties making it a more suitable input representation than strings."
 { $subsections
     wrap-words
-    word
-    <word>
+    wrapping-word
+    <wrapping-word>
 } ;
 
 HELP: wrap-words
-{ $values { "words" { "a sequence of " { $instance word } "s" } } { "line-max" integer } { "line-ideal" integer } { "lines" "a sequence of sequences of words" } }
+{ $values { "words" { "a sequence of " { $instance wrapping-word } "s" } } { "line-max" integer } { "line-ideal" integer } { "lines" "a sequence of sequences of words" } }
 { $description "Divides the words into lines, where the sum of the lengths of the words on a line (not counting breaks at the end of the line) is at most the given maximum. The returned set of lines is optimized to minimize the square of the deviation of each line from the ideal width. It is not guaranteed to be the minimal number of lines. Every line except for the first one starts with a non-break, and every one but the last ends with a break." } ;
 
-HELP: word
-{ $class-description "A word is a Factor object annotated with a length (in the " { $snippet "width" } " slot) and knowledge about whether it is an allowable position for an optional line break (in the " { $snippet "break?" } " slot). Words can be created with " { $link <word> } "." }
+HELP: wrapping-word
+{ $class-description "A word is a Factor object annotated with a length (in the " { $snippet "width" } " slot) and knowledge about whether it is an allowable position for an optional line break (in the " { $snippet "break?" } " slot). Words can be created with " { $link <wrapping-word> } "." }
 { $see-also wrap-words } ;
 
-HELP: <word>
-{ $values { "key" object } { "width" integer } { "break?" { { $link t } " or " { $link POSTPONE: f } } } { "word" word } }
-{ $description "Creates a " { $link word } " object with the given parameters." }
+HELP: <wrapping-word>
+{ $values { "key" object } { "width" integer } { "break?" { { $link t } " or " { $link POSTPONE: f } } } { "wrapping-word" wrapping-word } }
+{ $description "Creates a " { $link wrapping-word } " object with the given parameters." }
 { $see-also wrap-words } ;