use radix literals

[factor.git] / basis / math / bits / bits-docs.factor

diff --git a/basis/math/bits/bits-docs.factor b/basis/math/bits/bits-docs.factor
index 6ae83f7af0163f58b319445d1bdcd444893997f0..ecf53b6a08f025759971f8aa355a37659fbcc857 100644 (file)
--- a/basis/math/bits/bits-docs.factor
+++ b/basis/math/bits/bits-docs.factor
@@ -1,14 +1,17 @@
 ! Copyright (C) 2009 Daniel Ehrenberg
 ! See http://factorcode.org/license.txt for BSD license.
-USING: help.syntax help.markup math ;
+USING: help.syntax help.markup math sequences ;
 IN: math.bits
 
 ABOUT: "math.bits"
 
 ARTICLE: "math.bits" "Number bits virtual sequence"
-{ $subsection bits }
-{ $subsection <bits> }
-{ $subsection make-bits } ;
+"The " { $vocab-link "math.bits" } " vocabulary implements a virtual sequence which presents an integer as a sequence of bits, with the first element of the sequence being the least significant bit of the integer."
+{ $subsections
+    bits
+    <bits>
+    make-bits
+} ;
 
 HELP: bits
 { $class-description "Virtual sequence class of bits of a number. The first bit is the least significant bit. This can be constructed with " { $link <bits> } " or " { $link make-bits } "." } ;
@@ -21,6 +24,10 @@ HELP: make-bits
 { $values { "number" integer } { "bits" bits } }
 { $description "Creates a " { $link bits } " object out of the given number, using its log base 2 as the length. This implies that the last element, corresponding to the most significant bit, will be 1." }
 { $examples
-    { $example "USING: math.bits prettyprint arrays ;" "BIN: 1101 make-bits >array ." "{ t f t t }" }
+    { $example "USING: math.bits prettyprint arrays ;" "0b1101 make-bits >array ." "{ t f t t }" }
     { $example "USING: math.bits prettyprint arrays ;" "-3 make-bits >array ." "{ t f }" }
 } ;
+
+HELP: unbits
+{ $values { "seq" sequence } { "number" integer } }
+{ $description "Turns a sequence of booleans, of the same format made by the " { $link bits } " class, and calculates the number that it represents as little-endian." } ;