ilyakooo0/streamly
1
0
Fork 0
mirror of https://github.com/ilyakooo0/streamly.git synced 2024-09-17 11:37:20 +03:00
Code Issues Packages Projects Releases Wiki Activity

Make the Eq instance doc clearer.

Browse Source 
Avoid using byteCmp example, it may give an impression of how the
instance is defined.
This commit is contained in:
Harendra Kumar 2024-01-01 10:07:08 +05:30
parent 0ebc91ccab
commit 5274d3f1e3
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
core/src/Streamly/Internal/Data/Array/Type.hs
View File

@ -879,13 +879,9 @@ MK_EQ_INSTANCE(Int16)
MK_EQ_INSTANCE(Int32)
MK_EQ_INSTANCE(Int64)
-- | If the type allows a byte-by-byte comparison (see 'byteCmp') this instance
-- can be overlapped by a more specific instance that uses a byte comparison.
-- Byte comparison can be significantly faster.
--
-- For example:
--
-- >>> (==) = byteCmp
-- | If the type allows a byte-by-byte comparison this instance can be
-- overlapped by a more specific instance that uses 'byteCmp'. Byte comparison
-- can be significantly faster.
--
instance {-# OVERLAPPABLE #-} (Unbox a, Eq a) => Eq (Array a) where
{-# INLINE (==) #-}