From 8df32ea9e4f041328645a3cedc25312aee44705e Mon Sep 17 00:00:00 2001 From: Doug Coleman Date: Tue, 2 Sep 2008 16:49:45 -0500 Subject: [PATCH] update the docs --- core/io/encodings/binary/binary-docs.factor | 9 +++++++-- core/io/encodings/utf8/utf8-docs.factor | 9 +++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/core/io/encodings/binary/binary-docs.factor b/core/io/encodings/binary/binary-docs.factor index 85045d8984..4da1e0811f 100644 --- a/core/io/encodings/binary/binary-docs.factor +++ b/core/io/encodings/binary/binary-docs.factor @@ -2,5 +2,10 @@ USING: help.syntax help.markup ; 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" } ; +{ $class-description "Encoding descriptor for binary I/O." } ; + +ARTICLE: "io.encodings.binary" "Binary encoding" +"Making an encoded stream with the binary encoding is a no-op; streams with this encoding deal with byte-arrays, not strings." +{ $subsection binary } ; + +ABOUT: "io.encodings.binary" diff --git a/core/io/encodings/utf8/utf8-docs.factor b/core/io/encodings/utf8/utf8-docs.factor index 1ac0252dbb..7e185fff69 100755 --- a/core/io/encodings/utf8/utf8-docs.factor +++ b/core/io/encodings/utf8/utf8-docs.factor @@ -2,5 +2,10 @@ USING: help.markup help.syntax ; 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" } ; +{ $class-description "Encoding descriptor for UTF-8 encoding." } ; + +ARTICLE: "io.encodings.utf8" "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." +{ $subsection utf8 } ; + +ABOUT: "io.encodings.utf8"