steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Change to encodings docs

db4
Daniel Ehrenberg 2008-03-23 00:58:17 -04:00
parent d967d04e4c
commit 7888601949
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
core/io/encodings/encodings-docs.factor
View File

@ -10,6 +10,7 @@ ARTICLE: "io.encodings" "I/O encodings"
{ $subsection "encodings-protocol" } ; { $subsection "encodings-protocol" } ;
ARTICLE: "encodings-constructors" "Constructing an encoded stream" ARTICLE: "encodings-constructors" "Constructing an encoded stream"
"The following words can be used to construct encoded streams. Note that they are usually not used directly, but rather by the stream constructors themselves."
{ $subsection <encoder> } { $subsection <encoder> }
{ $subsection <decoder> } { $subsection <decoder> }
{ $subsection <encoder-duplex> } ; { $subsection <encoder-duplex> } ;
@ -47,7 +48,7 @@ ARTICLE: "encodings-protocol" "Encoding protocol"
"An encoding descriptor must implement the following methods. The methods are implemented on tuple classes by instantiating the class and calling the method again." "An encoding descriptor must implement the following methods. The methods are implemented on tuple classes by instantiating the class and calling the method again."
{ $subsection decode-char } { $subsection decode-char }
{ $subsection encode-char } { $subsection encode-char }
"The following methods are optional:" "Optionally, an encoding can override the constructor words:"
{ $subsection <encoder> } { $subsection <encoder> }
{ $subsection <decoder> } ; { $subsection <decoder> } ;