Skip to content

Commit

Permalink
Remove separate strictness section in IntSet docs (#1033)
Browse files Browse the repository at this point in the history
Mention strictness in the structure description, as done in other
modules.
  • Loading branch information
meooow25 authored Sep 7, 2024
1 parent e3bd02d commit 7a85bc6
Showing 1 changed file with 2 additions and 14 deletions.
16 changes: 2 additions & 14 deletions containers/src/Data/IntSet.hs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
--
-- = Finite Int Sets
--
-- The @'IntSet'@ type represents a set of elements of type @Int@.
-- The @'IntSet'@ type represents a set of elements of type @Int@. An @IntSet@
-- is strict in its elements.
--
-- For a walkthrough of the most commonly used functions see their
-- <https://haskell-containers.readthedocs.io/en/latest/set.html sets introduction>.
Expand Down Expand Up @@ -61,9 +62,6 @@
-----------------------------------------------------------------------------

module Data.IntSet (
-- * Strictness properties
-- $strictness

-- * Set type
#if !defined(TESTING)
IntSet -- instance Eq,Show
Expand Down Expand Up @@ -162,13 +160,3 @@ module Data.IntSet (

import Data.IntSet.Internal.IntTreeCommons (Key)
import Data.IntSet.Internal as IS

-- $strictness
--
-- This module satisfies the following strictness property:
--
-- * Key arguments are evaluated to WHNF
--
-- Here are some examples that illustrate the property:
--
-- > delete undefined s == undefined

0 comments on commit 7a85bc6

Please sign in to comment.