From 5dbf68f3852192e708c245c123a3f084c371d463 Mon Sep 17 00:00:00 2001 From: Doug Coleman Date: Tue, 2 Sep 2008 16:49:21 -0500 Subject: [PATCH] update the docs --- basis/io/encodings/ascii/ascii-docs.factor | 9 +++++++-- basis/io/encodings/utf16/utf16-docs.factor | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/basis/io/encodings/ascii/ascii-docs.factor b/basis/io/encodings/ascii/ascii-docs.factor index 9c9c3a5234..fa496a3526 100644 --- a/basis/io/encodings/ascii/ascii-docs.factor +++ b/basis/io/encodings/ascii/ascii-docs.factor @@ -2,5 +2,10 @@ USING: help.markup help.syntax ; 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" } ; +{ $class-description "ASCII encoding descriptor." } ; + +ARTICLE: "ascii" "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." +{ $subsection ascii } ; + +ABOUT: "ascii" diff --git a/basis/io/encodings/utf16/utf16-docs.factor b/basis/io/encodings/utf16/utf16-docs.factor index f37a9d1d58..dc499b5ed4 100644 --- a/basis/io/encodings/utf16/utf16-docs.factor +++ b/basis/io/encodings/utf16/utf16-docs.factor @@ -1,7 +1,7 @@ USING: help.markup help.syntax io.encodings strings ; IN: io.encodings.utf16 -ARTICLE: "io.encodings.utf16" "UTF-16" +ARTICLE: "io.encodings.utf16" "UTF-16 encoding" "The UTF-16 encoding is a variable-width encoding. Unicode code points are encoded as 2 or 4 byte sequences. There are three encoding descriptor classes for working with UTF-16, depending on endianness or the presence of a BOM:" { $subsection utf16 } { $subsection utf16le }