From 8347710dd598df385026d753bb5b3a4274247d33 Mon Sep 17 00:00:00 2001 From: Slava Pestov Date: Fri, 4 Jul 2008 02:52:27 -0500 Subject: [PATCH] Help lint fixes --- core/generic/math/math-docs.factor | 2 +- core/io/encodings/binary/binary-docs.factor | 2 -- core/io/encodings/utf8/utf8-docs.factor | 2 -- core/memory/memory-docs.factor | 2 +- core/sequences/sequences-docs.factor | 4 ++-- extra/bit-arrays/bit-arrays-docs.factor | 4 ++-- extra/float-arrays/float-arrays-docs.factor | 4 ++-- extra/help/crossref/crossref-docs.factor | 2 +- extra/io/encodings/ascii/ascii-docs.factor | 2 -- extra/io/encodings/strict/strict-docs.factor | 2 -- extra/math/complex/complex-docs.factor | 2 +- extra/tuple-syntax/tuple-syntax-docs.factor | 3 --- extra/unicode/script/script-docs.factor | 2 -- 13 files changed, 10 insertions(+), 23 deletions(-) diff --git a/core/generic/math/math-docs.factor b/core/generic/math/math-docs.factor index 5c15e43eb5..b0201f3248 100755 --- a/core/generic/math/math-docs.factor +++ b/core/generic/math/math-docs.factor @@ -15,7 +15,7 @@ HELP: no-math-method HELP: math-method { $values { "word" generic } { "class1" class } { "class2" class } { "quot" quotation } } { $description "Generates a definition for " { $snippet "word" } " when the two inputs are instances of " { $snippet "class1" } " and " { $snippet "class2" } ", respectively." } -{ $examples { $example "USING: generic.math math prettyprint ;" "\\ + fixnum float math-method ." "[ [ >float ] dip +/float ]" } } ; +{ $examples { $example "USING: generic.math math prettyprint ;" "\\ + fixnum float math-method ." "[ [ >float ] dip float=>+ ]" } } ; HELP: math-class { $class-description "The class of subtypes of " { $link number } " which are not " { $link null } "." } ; diff --git a/core/io/encodings/binary/binary-docs.factor b/core/io/encodings/binary/binary-docs.factor index fdd9828867..85045d8984 100644 --- a/core/io/encodings/binary/binary-docs.factor +++ b/core/io/encodings/binary/binary-docs.factor @@ -4,5 +4,3 @@ IN: io.encodings.binary HELP: binary { $class-description "This is the encoding descriptor for binary I/O. Making an encoded stream with the binary encoding is a no-op; streams with this encoding deal with byte-arrays, not strings." } { $see-also "encodings-introduction" } ; - -ABOUT: binary diff --git a/core/io/encodings/utf8/utf8-docs.factor b/core/io/encodings/utf8/utf8-docs.factor index 7a29039eca..1ac0252dbb 100755 --- a/core/io/encodings/utf8/utf8-docs.factor +++ b/core/io/encodings/utf8/utf8-docs.factor @@ -4,5 +4,3 @@ IN: io.encodings.utf8 HELP: utf8 { $class-description "This is the encoding descriptor for a UTF-8 encoding. UTF-8 is a variable-width encoding. 7-bit ASCII characters are encoded as single bytes, and other Unicode code points are encoded as 2 to 4 byte sequences." } { $see-also "encodings-introduction" } ; - -ABOUT: utf8 diff --git a/core/memory/memory-docs.factor b/core/memory/memory-docs.factor index 38f39ec588..1213245863 100755 --- a/core/memory/memory-docs.factor +++ b/core/memory/memory-docs.factor @@ -9,7 +9,7 @@ ARTICLE: "images" "Images" "To start Factor with a custom image, use the " { $snippet "-i=" { $emphasis "image" } } " command line switch; see " { $link "runtime-cli-args" } "." { $see-also "tools.memory" } ; -ABOUT: "image" +ABOUT: "images" HELP: begin-scan ( -- ) { $description "Moves all objects to tenured space, disables the garbage collector, and resets the heap scan pointer to point at the first object in the heap. The " { $link next-object } " word can then be called to advance the heap scan pointer and return successive objects." diff --git a/core/sequences/sequences-docs.factor b/core/sequences/sequences-docs.factor index d33ef834c4..dc8d7b9789 100755 --- a/core/sequences/sequences-docs.factor +++ b/core/sequences/sequences-docs.factor @@ -965,7 +965,7 @@ HELP: sigma { $description "Like map sum, but without creating an intermediate sequence." } { $example "! Find the sum of the squares [0,99]" - "USING: math math.ranges sequences.lib prettyprint ;" + "USING: math math.ranges sequences prettyprint ;" "100 [1,b] [ sq ] sigma ." "338350" } ; @@ -974,7 +974,7 @@ HELP: count { $values { "seq" sequence } { "quot" quotation } { "n" integer } } { $description "Efficiently returns the number of elements that the predicate quotation matches." } { $example - "USING: math math.ranges sequences.lib prettyprint ;" + "USING: math math.ranges sequences prettyprint ;" "100 [1,b] [ even? ] count ." "50" } ; diff --git a/extra/bit-arrays/bit-arrays-docs.factor b/extra/bit-arrays/bit-arrays-docs.factor index e8fbd19215..46033c61a8 100644 --- a/extra/bit-arrays/bit-arrays-docs.factor +++ b/extra/bit-arrays/bit-arrays-docs.factor @@ -3,7 +3,7 @@ kernel.private math prettyprint strings vectors sbufs ; IN: bit-arrays ARTICLE: "bit-arrays" "Bit arrays" -"Bit array are a fixed-size mutable sequences (" { $link "sequence-protocol" } ") whose elements are either " { $link t } " or " { $link f } ". Each element only uses one bit of storage, hence the name. The literal syntax is covered in " { $link "syntax-bit-arrays" } "." +"Bit array are a fixed-size mutable sequences (" { $link "sequence-protocol" } ") whose elements are either " { $link t } " or " { $link f } ". Each element only uses one bit of storage, hence the name." $nl "Bit array words are in the " { $vocab-link "bit-arrays" } " vocabulary." $nl @@ -33,7 +33,7 @@ HELP: ?{ { $examples { $code "?{ t f t }" } } ; HELP: bit-array -{ $description "The class of fixed-length bit arrays. See " { $link "syntax-bit-arrays" } " for syntax and " { $link "bit-arrays" } " for general information." } ; +{ $description "The class of fixed-length bit arrays." } ; HELP: ( n -- bit-array ) { $values { "n" "a non-negative integer" } { "bit-array" "a new " { $link bit-array } } } diff --git a/extra/float-arrays/float-arrays-docs.factor b/extra/float-arrays/float-arrays-docs.factor index 3770b86918..6c775dbd78 100644 --- a/extra/float-arrays/float-arrays-docs.factor +++ b/extra/float-arrays/float-arrays-docs.factor @@ -3,7 +3,7 @@ kernel help.markup help.syntax math ; IN: float-arrays ARTICLE: "float-arrays" "Float arrays" -"Float arrays are fixed-size mutable sequences (" { $link "sequence-protocol" } ") whose elements are instances of " { $link float } ". Elements are unboxed, hence the memory usage is lower than an equivalent " { $link array } " of floats. The literal syntax is covered in " { $link "syntax-float-arrays" } "." +"Float arrays are fixed-size mutable sequences (" { $link "sequence-protocol" } ") whose elements are instances of " { $link float } ". Elements are unboxed, hence the memory usage is lower than an equivalent " { $link array } " of floats." $nl "Float array words are in the " { $vocab-link "float-arrays" } " vocabulary." $nl @@ -32,7 +32,7 @@ HELP: F{ { $examples { $code "F{ 1.0 2.0 3.0 }" } } ; HELP: float-array -{ $description "The class of float arrays. See " { $link "syntax-float-arrays" } " for syntax and " { $link "float-arrays" } " for general information." } ; +{ $description "The class of float arrays." } ; HELP: ( n -- float-array ) { $values { "n" "a non-negative integer" } { "float-array" "a new float array" } } diff --git a/extra/help/crossref/crossref-docs.factor b/extra/help/crossref/crossref-docs.factor index 4331a45490..6ec35b23ce 100644 --- a/extra/help/crossref/crossref-docs.factor +++ b/extra/help/crossref/crossref-docs.factor @@ -13,7 +13,7 @@ HELP: help-path { $values { "topic" "an article name or a word" } { "seq" "a new sequence" } } { $description "Outputs a sequence of all help articles which contain " { $snippet "topic" } " as a subsection, traversing all the way up to the root." } { $examples - { $example "USING: help.crossref prettyprint ;" "\"sequences\" help-path ." "{ \"collections\" \"handbook\" }" } + { $example "USING: help.crossref prettyprint ;" "\"sequences\" help-path ." "{ \"collections\" \"handbook-language-reference\" \"handbook\" }" } } ; HELP: xref-article diff --git a/extra/io/encodings/ascii/ascii-docs.factor b/extra/io/encodings/ascii/ascii-docs.factor index 0b54a341d9..9c9c3a5234 100644 --- a/extra/io/encodings/ascii/ascii-docs.factor +++ b/extra/io/encodings/ascii/ascii-docs.factor @@ -4,5 +4,3 @@ IN: io.encodings.ascii HELP: ascii { $class-description "This is the encoding descriptor which denotes an ASCII encoding. By default, if there's a non-ASCII character in an input stream, it will be replaced with a replacement character (U+FFFD), and if a non-ASCII character is used in output, an exception is thrown." } { $see-also "encodings-introduction" } ; - -ABOUT: ascii diff --git a/extra/io/encodings/strict/strict-docs.factor b/extra/io/encodings/strict/strict-docs.factor index e8a4f18179..b7edec2de7 100644 --- a/extra/io/encodings/strict/strict-docs.factor +++ b/extra/io/encodings/strict/strict-docs.factor @@ -6,5 +6,3 @@ IN: io.encodings.strict HELP: strict ( encoding -- strict-encoding ) { $values { "encoding" "an encoding descriptor" } { "strict-encoding" "a strict encoding descriptor" } } { $description "Makes an encoding strict, that is, in the presence of a malformed code point, an error is thrown. Note that the existence of a replacement character in a file (U+FFFD) also throws an error." } ; - -ABOUT: strict diff --git a/extra/math/complex/complex-docs.factor b/extra/math/complex/complex-docs.factor index 82cb14c391..d723d55cb3 100755 --- a/extra/math/complex/complex-docs.factor +++ b/extra/math/complex/complex-docs.factor @@ -18,7 +18,7 @@ $nl HELP: complex { $class-description "The class of complex numbers with non-zero imaginary part." } ; -ABOUT: "math.complex" +ABOUT: "complex-numbers" HELP: 2>rect { $values { "x" "a complex number" } { "y" "a complex number" } { "xr" "real part of " { $snippet "x" } } { "xi" "imaginary part of " { $snippet "x" } } { "yr" "real part of " { $snippet "y" } } { "yi" "imaginary part of " { $snippet "y" } } } diff --git a/extra/tuple-syntax/tuple-syntax-docs.factor b/extra/tuple-syntax/tuple-syntax-docs.factor index aacc48f9e5..d27cf27c9b 100644 --- a/extra/tuple-syntax/tuple-syntax-docs.factor +++ b/extra/tuple-syntax/tuple-syntax-docs.factor @@ -6,6 +6,3 @@ HELP: TUPLE{ { $values { "class" "a tuple class word" } { "slot-name" "the name of a slot, without the tuple class name" } { "value" "the value for a slot" } } { $description "Marks the beginning of a literal tuple. Literal tuples are terminated by " { $link POSTPONE: } } ". The class word must be specified. Slots which aren't specified are set to f. If slot names are duplicated, the latest one is used." } { $see-also POSTPONE: T{ } ; - -IN: tuple-syntax -ABOUT: POSTPONE: TUPLE{ diff --git a/extra/unicode/script/script-docs.factor b/extra/unicode/script/script-docs.factor index 05828b778f..6612825c21 100755 --- a/extra/unicode/script/script-docs.factor +++ b/extra/unicode/script/script-docs.factor @@ -4,5 +4,3 @@ IN: unicode.script HELP: script-of { $values { "char" "a code point" } { "script" "a symbol" } } { $description "Gets a symbol representing the code point of a given character. The word name of the symbol is the same as the one " } ; - -ABOUT: script-of