clarify meaning of bit
authorSimon Marlow <marlowsd@gmail.com>
Wed, 14 Jul 2010 10:33:10 +0000 (10:33 +0000)
committerSimon Marlow <marlowsd@gmail.com>
Wed, 14 Jul 2010 10:33:10 +0000 (10:33 +0000)
Data/Bits.hs

index 62b64a3..8b5432b 100644 (file)
@@ -126,7 +126,7 @@ class Num a => Bits a where
                   | i>0  = (x `shift` i) .|. (x `shift` (i-bitSize x))
     -}
 
-    -- | @bit i@ is a value with the @i@th bit set
+    -- | @bit i@ is a value with the @i@th bit set and all other bits clear
     bit               :: Int -> a
 
     -- | @x \`setBit\` i@ is the same as @x .|. bit i@