]> gitweb.factorcode.org Git - factor.git/commitdiff
Help lint fixes
authorSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Fri, 4 Jul 2008 07:52:27 +0000 (02:52 -0500)
committerSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Fri, 4 Jul 2008 07:52:27 +0000 (02:52 -0500)
13 files changed:
core/generic/math/math-docs.factor
core/io/encodings/binary/binary-docs.factor
core/io/encodings/utf8/utf8-docs.factor
core/memory/memory-docs.factor
core/sequences/sequences-docs.factor
extra/bit-arrays/bit-arrays-docs.factor
extra/float-arrays/float-arrays-docs.factor
extra/help/crossref/crossref-docs.factor
extra/io/encodings/ascii/ascii-docs.factor
extra/io/encodings/strict/strict-docs.factor
extra/math/complex/complex-docs.factor
extra/tuple-syntax/tuple-syntax-docs.factor
extra/unicode/script/script-docs.factor

index 5c15e43eb567e9b511aff1f6dd7d89c8fa18b220..b0201f3248679e1fa6b8c72e06e9df566711f71d 100755 (executable)
@@ -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 } "." } ;
index fdd9828867c6e060d7dc77e5d84912ec48219d5e..85045d8984ac06555bfb3cf1518c49da48dbab25 100644 (file)
@@ -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
index 7a29039eca25688348a293b578a68d60eb70b1f4..1ac0252dbb8f0b43e60efa1c70211e9339868b1c 100755 (executable)
@@ -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
index 38f39ec588e63aebb63227e9276f7eccb14f2b9b..1213245863487d32ad516ed27a052389a70398ca 100755 (executable)
@@ -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."
index d33ef834c4ff6b0f82f08d4f24b4899fadbf4de6..dc8d7b9789a9ab84b6cd8733611361092b9e5a94 100755 (executable)
@@ -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"
 } ;
index e8fbd192158e07950903663c2a0b00cab9cd3454..46033c61a82a1636486f40b4ebf17b5497bad1f3 100644 (file)
@@ -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: <bit-array> ( n -- bit-array )
 { $values { "n" "a non-negative integer" } { "bit-array" "a new " { $link bit-array } } }
index 3770b8691843cdced8890907ea8af57653da6070..6c775dbd788b0a9875808cbf312e72ddcc8825ac 100644 (file)
@@ -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: <float-array> ( n -- float-array )
 { $values { "n" "a non-negative integer" } { "float-array" "a new float array" } }
index 4331a454903744dbf5ef11b628ad519b2ef31151..6ec35b23cede601de9ac6715ce7590b231ac163f 100644 (file)
@@ -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
index 0b54a341d903f9807c7f72a10de19edaa883cf86..9c9c3a523415c2137631c425aa0787560938c276 100644 (file)
@@ -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
index e8a4f1817909d95aabb436dfa7459f8c6c1c32a4..b7edec2de7bb80517d5ad2d01e423e0bac6d328f 100644 (file)
@@ -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
index 82cb14c391fbbf03e7ce845b4232a6e4e166c322..d723d55cb3f812f6ab8158ae82546806fe6e503a 100755 (executable)
@@ -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" } } }
index aacc48f9e58f4834600cdd2cd755e6ea01cf0d64..d27cf27c9b16bca4f3771fadbe611cc1e8512877 100644 (file)
@@ -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{
index 05828b778f6e21a538a1f815170afedd2f93c1a1..6612825c21eb971f833ee9783df862e62041f8ec 100755 (executable)
@@ -4,5 +4,3 @@ IN: unicode.script
 HELP: script-of\r
 { $values { "char" "a code point" } { "script" "a symbol" } }\r
 { $description "Gets a symbol representing the code point of a given character. The word name of the symbol is the same as the one " } ;\r
-\r
-ABOUT: script-of\r