]> gitweb.factorcode.org Git - factor.git/blobdiff - basis/base64/base64-docs.factor
build: add a make clean target, delete overlooked factor binary in make clean
[factor.git] / basis / base64 / base64-docs.factor
index 530caab8bddd8ad90c8c2af0aaad97059aaa5470..e474cd8437b851d9289080f8dfdb6c6daf130cae 100644 (file)
@@ -1,18 +1,18 @@
-USING: help.markup help.syntax kernel math sequences ;
+USING: help.markup help.syntax sequences ;
 IN: base64
 
 HELP: >base64
 { $values { "seq" sequence } { "base64" "a string of base64 characters" } }
-{ $description "Converts a sequence to its base64 representation by taking six bits at a time as an index into a lookup table containing alphanumerics, '+', and '/'.  The result is padded with '=' if the input was not a multiple of six bits." }
+{ $description "Converts a sequence to its base64 representation by taking six bits at a time as an index into a lookup table containing alphanumerics, '+', and '/'. The result is padded with '=' if the input was not a multiple of six bits." }
 { $examples
     { $example "USING: prettyprint base64 strings ;" "\"The monorail is a free service.\" >base64 >string ." "\"VGhlIG1vbm9yYWlsIGlzIGEgZnJlZSBzZXJ2aWNlLg==\"" }
 }
-{ $see-also base64> >base64-lines } ;
+{ $see-also >base64-lines base64> } ;
 
 HELP: >base64-lines
 { $values { "seq" sequence } { "base64" "a string of base64 characters" } }
-{ $description "Converts a sequence to its base64 representation by taking six bits at a time as an index into a lookup table containing alphanumerics, '+', and '/'.  The result is padded with '=' if the input was not a multiple of six bits. A crlf is inserted for every 76 characters of output." }
-{ $see-also base64> >base64-lines } ;
+{ $description "Converts a sequence to its base64 representation by taking six bits at a time as an index into a lookup table containing alphanumerics, '+', and '/'. The result is padded with '=' if the input was not a multiple of six bits. A crlf is inserted for every 76 characters of output." }
+{ $see-also >base64 base64> } ;
 
 
 HELP: base64>
@@ -36,12 +36,16 @@ HELP: encode-base64-lines
 ARTICLE: "base64" "Base 64 conversions"
 "The " { $vocab-link "base64" } " vocabulary implements conversions of sequences to printable characters in base 64. These plain-text representations of binary data may be passed around and converted back to binary data later." $nl
 "Converting to and from base64 as strings:"
-{ $subsection >base64 }
-{ $subsection >base64-lines }
-{ $subsection base64> }
+{ $subsections
+    >base64
+    >base64-lines
+    base64>
+}
 "Using base64 from streams:"
-{ $subsection encode-base64 }
-{ $subsection encode-base64-lines }
-{ $subsection decode-base64 } ;
+{ $subsections
+    encode-base64
+    encode-base64-lines
+    decode-base64
+} ;
 
 ABOUT: "base64"