Commit 3241ac56 authored by Herbert Valerio Riedel's avatar Herbert Valerio Riedel 🕺
Browse files

Remove incorrect property in docstring (re #9532)

The property

  countLeadingZeros . negate = const 0

doesn't generally hold and it's not such a useful property to state, as
it simply follows from "sign-bit == most-significant-bit" for FiniteBits
types which use twos-complement representation for negative values, and
even then it breaks down for 0...

TLDR, remove thinko from documentation of `countLeadingZeros`
parent 737f3682
......@@ -296,7 +296,6 @@ class Bits b => FiniteBits b where
--
-- @
-- 'countLeadingZeros' ('zeroBits' :: a) = finiteBitSize ('zeroBits' :: a)
-- 'countLeadingZeros' . 'negate' = 'const' 0
-- @
--
-- 'countLeadingZeros' can be used to compute log base 2 via
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment