on master help sign in
Make the Eq instance doc clearer.

Avoid using byteCmp example, it may give an impression of how the instance is defined.

commit5274d3f1e33dc59135c17dfa61581fada621b595 authorHarendra Kumar <harendra@composewell.com> dateMon 1 Jan 2024, 10:07 (3 years ago) parent0ebc91c
1 file changed+3−7
core/src/Streamly/Internal/Data/Array/Type.hs+3−7
core/src/Streamly/Internal/Data/Array/Type.hs+3−7
@@ -879,13 +879,9 @@ MK_EQ_INSTANCE(Int16)
879879MK_EQ_INSTANCE(Int32)
880880MK_EQ_INSTANCE(Int64)
881881
882−-- | If the type allows a byte-by-byte comparison (see 'byteCmp') this instance
883−-- can be overlapped by a more specific instance that uses a byte comparison.
884−-- Byte comparison can be significantly faster.
885−--
886−-- For example:
887−--
888−-- >>> (==) = byteCmp
882+-- | If the type allows a byte-by-byte comparison this instance can be
883+-- overlapped by a more specific instance that uses 'byteCmp'. Byte comparison
884+-- can be significantly faster.
889885--
890886instance {-# OVERLAPPABLE #-} (Unbox a, Eq a) => Eq (Array a) where
891887 {-# INLINE (==) #-}