From df41c8b68f44a04209ef484a8f689f358266159c Mon Sep 17 00:00:00 2001 From: Slava Pestov Date: Wed, 23 Apr 2008 02:46:35 -0500 Subject: [PATCH] Fix documentation --- core/alien/strings/strings-docs.factor | 4 ++-- core/alien/strings/strings.factor | 2 +- extra/bit-vectors/bit-vectors-docs.factor | 4 ++-- extra/byte-vectors/byte-vectors-docs.factor | 2 +- extra/columns/columns-docs.factor | 2 +- extra/float-vectors/float-vectors-docs.factor | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/core/alien/strings/strings-docs.factor b/core/alien/strings/strings-docs.factor index 0dbb4ffd38..27b0122ebe 100644 --- a/core/alien/strings/strings-docs.factor +++ b/core/alien/strings/strings-docs.factor @@ -3,14 +3,14 @@ debugger ; IN: alien.strings HELP: string>alien -{ $values { "string" string } { "encoding" "an encoding descriptor" } { "array" byte-array } } +{ $values { "string" string } { "encoding" "an encoding descriptor" } { "byte-array" byte-array } } { $description "Encodes a string together with a trailing null code point using the given encoding, and stores the resulting bytes in a freshly-allocated byte array." } { $errors "Throws an error if the string contains null characters, or characters not representable in the given encoding." } ; { string>alien alien>string malloc-string } related-words HELP: alien>string -{ $values { "c-ptr" c-ptr } { "encoding" "an encoding descriptor" } { "string" string } } +{ $values { "c-ptr" c-ptr } { "encoding" "an encoding descriptor" } { "string/f" "a string or " { $link f } } } { $description "Reads a null-terminated C string from the specified address with the given encoding." } ; HELP: malloc-string diff --git a/core/alien/strings/strings.factor b/core/alien/strings/strings.factor index 463fc11e0d..d69d8e9e8e 100644 --- a/core/alien/strings/strings.factor +++ b/core/alien/strings/strings.factor @@ -6,7 +6,7 @@ io.streams.byte-array io.streams.memory io.encodings.utf8 io.encodings.utf16 system alien strings cpu.architecture ; IN: alien.strings -GENERIC# alien>string 1 ( alien encoding -- string/f ) +GENERIC# alien>string 1 ( c-ptr encoding -- string/f ) M: c-ptr alien>string >r r> diff --git a/extra/bit-vectors/bit-vectors-docs.factor b/extra/bit-vectors/bit-vectors-docs.factor index 9ceb2df342..41f32b4cdb 100755 --- a/extra/bit-vectors/bit-vectors-docs.factor +++ b/extra/bit-vectors/bit-vectors-docs.factor @@ -3,7 +3,7 @@ bit-vectors.private combinators ; IN: bit-vectors ARTICLE: "bit-vectors" "Bit vectors" -"A bit vector is a resizable mutable sequence of bits. The literal syntax is covered in " { $link "syntax-bit-vectors" } ". Bit vector words are found in the " { $vocab-link "bit-vectors" } " vocabulary." +"A bit vector is a resizable mutable sequence of bits. Bit vector words are found in the " { $vocab-link "bit-vectors" } " vocabulary." $nl "Bit vectors form a class:" { $subsection bit-vector } @@ -19,7 +19,7 @@ $nl ABOUT: "bit-vectors" HELP: bit-vector -{ $description "The class of resizable bit vectors. See " { $link "syntax-bit-vectors" } " for syntax and " { $link "bit-vectors" } " for general information." } ; +{ $description "The class of resizable bit vectors. See " { $link "bit-vectors" } " for information." } ; HELP: { $values { "n" "a positive integer specifying initial capacity" } { "bit-vector" bit-vector } } diff --git a/extra/byte-vectors/byte-vectors-docs.factor b/extra/byte-vectors/byte-vectors-docs.factor index f34bc20219..139cbab822 100755 --- a/extra/byte-vectors/byte-vectors-docs.factor +++ b/extra/byte-vectors/byte-vectors-docs.factor @@ -19,7 +19,7 @@ $nl ABOUT: "byte-vectors" HELP: byte-vector -{ $description "The class of resizable byte vectors. See " { $link "syntax-byte-vectors" } " for syntax and " { $link "byte-vectors" } " for general information." } ; +{ $description "The class of resizable byte vectors. See " { $link "byte-vectors" } " for information." } ; HELP: { $values { "n" "a positive integer specifying initial capacity" } { "byte-vector" byte-vector } } diff --git a/extra/columns/columns-docs.factor b/extra/columns/columns-docs.factor index 6b2adce9d9..a2f0cccf3b 100644 --- a/extra/columns/columns-docs.factor +++ b/extra/columns/columns-docs.factor @@ -14,7 +14,7 @@ HELP: ( seq n -- column ) { $description "Outputs a new virtual sequence which presents a fixed column of a matrix represented as a sequence of rows." "The " { $snippet "i" } "th element of a column is the " { $snippet "n" } "th element of the " { $snippet "i" } "th element of" { $snippet "seq" } ". Every element of " { $snippet "seq" } " must be a sequence, and all sequences must have equal length." } { $examples { $example - "USING: arrays prettyprint sequences ;" + "USING: arrays prettyprint columns ;" "{ { 1 2 3 } { 4 5 6 } { 7 8 9 } } 0 >array ." "{ 1 4 7 }" } diff --git a/extra/float-vectors/float-vectors-docs.factor b/extra/float-vectors/float-vectors-docs.factor index 8d25da54be..5e06f05a2b 100755 --- a/extra/float-vectors/float-vectors-docs.factor +++ b/extra/float-vectors/float-vectors-docs.factor @@ -3,7 +3,7 @@ float-vectors.private combinators ; IN: float-vectors ARTICLE: "float-vectors" "Float vectors" -"A float vector is a resizable mutable sequence of unsigned floats. The literal syntax is covered in " { $link "syntax-float-vectors" } ". Float vector words are found in the " { $vocab-link "float-vectors" } " vocabulary." +"A float vector is a resizable mutable sequence of unsigned floats. Float vector words are found in the " { $vocab-link "float-vectors" } " vocabulary." $nl "Float vectors form a class:" { $subsection float-vector } @@ -19,7 +19,7 @@ $nl ABOUT: "float-vectors" HELP: float-vector -{ $description "The class of resizable float vectors. See " { $link "syntax-float-vectors" } " for syntax and " { $link "float-vectors" } " for general information." } ; +{ $description "The class of resizable float vectors. See " { $link "float-vectors" } " for information." } ; HELP: { $values { "n" "a positive integer specifying initial capacity" } { "float-vector" float-vector } }