Haddocks: switch stability from provisional to stable

Author: andreasabel

src/Control/Concurrent/Thread/Utils.hs

@@ -12,7 +12,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2004-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 This module provides various helpful utilities for dealing with threads.

src/Data/BinPacking.hs

@@ -12,7 +12,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2008-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 Tools for packing into bins
@@ -39,10 +39,10 @@ where
 import Data.List
 import Control.Monad.Error
 
-{- | Potential errors returned as Left values by 'BinPacker' functions. 
+{- | Potential errors returned as Left values by 'BinPacker' functions.
 Calling 'show' on this value will produce a nice error message suitable for
 display. -}
-data (Num size, Ord size, Show size, Show obj) => BinPackerError size obj = 
+data (Num size, Ord size, Show size, Show obj) => BinPackerError size obj =
     BPTooFewBins [(size, obj)]                -- ^ Ran out of bins; attached value is the list of objects that do not fit
     | BPSizeTooLarge size (size, obj)   -- ^ Bin size1 exceeded by at least the given object and size
     | BPOther String                    -- ^ Other error
@@ -63,13 +63,13 @@ instance (Num size, Ord size, Show size, Show obj) => Error (BinPackerError size
 
 These functions take a list of size of bins.  If every bin is the same size,
 you can pass @repeat binSize@ to pass an infinite list of bins if the
-same size.  Any surplus bins will simply be ignored. 
+same size.  Any surplus bins will simply be ignored.
 
 > [size] is the sizes of bins
 > [(size, obj)] is the sizes and objects
 > result is Either error or results
 -}
-type BinPacker = forall size obj. (Num size, Ord size, Show size, Show obj) => 
+type BinPacker = forall size obj. (Num size, Ord size, Show size, Show obj) =>
                   [size]        -- The sizes of bins
                -> [(size, obj)] -- The sizes and objects
                -> Either (BinPackerError size obj) [[(size, obj)]] -- Either error or results
@@ -85,7 +85,7 @@ packByOrder _ [] = Right []                     -- Ran out of sizes
 packByOrder [] remainder = Left (BPTooFewBins remainder)
 packByOrder (thisbinsize:otherbins) sizes =
     let fillBin _ [] = Right []
-        fillBin accumsize ((s, o):xs) 
+        fillBin accumsize ((s, o):xs)
             | s > thisbinsize = Left $ BPSizeTooLarge thisbinsize (s, o)
             | s + accumsize > thisbinsize = Right []
             | otherwise = do next <- fillBin (accumsize + s) xs

src/Data/Bits/Utils.hs

@@ -12,7 +12,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2004-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable to platforms with rawSystem
 
   Bit-related utilities

src/Data/CSV.hs

@@ -12,7 +12,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2005-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 Haskell Parsec parsers for comma-separated value (CSV) files.

src/Data/Compression/Inflate.hs

@@ -19,7 +19,7 @@ as described by RFC 1951.
    Copyright  : Copyright (C) 2004 Ian Lynagh
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 Inflate algorithm implementation
@@ -363,5 +363,3 @@ make_tree i lcs@((l, c):lcs')
                (one_tree, lcs_o) = make_tree (i+1) lcs_z
            in (Branch zero_tree one_tree, lcs_o)
  | otherwise = error "make_tree: can't happen"
-
-

src/Data/Either/Utils.hs

@@ -12,7 +12,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2004-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 Utilities for working with the Either data type
@@ -77,4 +77,3 @@ fromRight _         = error "Data.Either.Utils.fromRight: Left"
 fromEither :: Either a a -> a
 fromEither (Left a)  = a
 fromEither (Right a) = a
-

src/Data/Hash/CRC32/GZip.hs

@@ -12,7 +12,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2004-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 CRC32 checksumming using the GZIP\/PKZIP algorithm as used in both

src/Data/Hash/MD5.hs

@@ -8,7 +8,7 @@
    SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0-or-later
 
    Maintainer : Ian Lynagh <igloo@earth.li>
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 Generation of MD5sums

src/Data/List/Utils.hs

@@ -12,7 +12,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2004-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 This module provides various helpful utilities for dealing with lists.

src/Data/MIME/Types.hs

@@ -13,7 +13,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2004-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 Utilities for guessing MIME types of files.

src/Data/Map/Utils.hs

@@ -12,7 +12,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2004-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 This module provides various helpful utilities for dealing with Data.Maps.

src/Data/Maybe/Utils.hs

@@ -12,7 +12,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2005-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 Utilities for working with the Either data type

src/Data/Progress/Meter.hs

@@ -13,7 +13,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2006-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 Tool for maintaining a status bar, supporting multiple simultaneous tasks,
@@ -219,5 +219,3 @@ renderMeterR meter =
                                             speed <- getSpeed pts
                                             return $ head (rfunc [floor (speed :: Double)]) ++ u ++
                                                        "/s " ++ renderSecs etr
-
-

src/Data/Progress/Tracker.hs

@@ -12,12 +12,12 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2006-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 Tools for tracking the status of a long operation.
 
-Written by John Goerzen, jgoerzen\@complete.org 
+Written by John Goerzen, jgoerzen\@complete.org
 
 See also "Data.Progress.Meter" -}
 
@@ -66,7 +66,7 @@ a large task is composed of several individual tasks which may also be
 long-running.  Downloading many large files over the Internet is a common
 example of this.
 
-Any given ProgressTracker can be told about one or more parent trackers.  
+Any given ProgressTracker can be told about one or more parent trackers.
 When the child tracker's status is updated, the parent tracker's status is
 also updated in the same manner.  Therefore, the progress on each individual
 component, as well as the overall progress, can all be kept in sync
@@ -95,7 +95,7 @@ Here is an example use:
 -- TYPES
 ----------------------------------------------------------------------
 
-{- | A function that, when called, yields the current time. 
+{- | A function that, when called, yields the current time.
 The default is 'defaultTimeSource'. -}
 type ProgressTimeSource = IO Integer
 
@@ -112,7 +112,7 @@ callback is running, so the callback will not be able to make changes to it. -}
 type ProgressCallback = ProgressStatus -> ProgressStatus -> IO ()
 
 {- | The main progress status record. -}
-data ProgressStatus = 
+data ProgressStatus =
      ProgressStatus {completedUnits :: Integer,
                      totalUnits :: Integer,
                      startTime :: Integer,
@@ -129,7 +129,7 @@ data ProgressRecord =
 newtype Progress = Progress (MVar ProgressRecord)
 
 class ProgressStatuses a b where
-    {- | Lets you examine the 'ProgressStatus' that is contained 
+    {- | Lets you examine the 'ProgressStatus' that is contained
        within a 'Progress' object.  You can simply pass
        a 'Progress' object and a function to 'withStatus', and
        'withStatus' will lock the 'Progress' object (blocking any
@@ -184,7 +184,7 @@ newProgress name total =
                                      timeSource = defaultTimeSource})
                     []
 
-{- | Create a new 'Progress' object initialized with the given status and 
+{- | Create a new 'Progress' object initialized with the given status and
 callbacks.
 No adjustment to the 'startTime' will be made.  If you
 want to use the system clock, you can initialize 'startTime' with
@@ -200,7 +200,7 @@ newProgress' news newcb =
 {- | Adds an new callback to an existing 'Progress'.  The callback will be
 called whenever the object's status is updated, except by the call to finishP.
 
-Please note that the Progress object will be locked while the callback is 
+Please note that the Progress object will be locked while the callback is
 running, so the callback will not be able to make any modifications to it.
 -}
 addCallback :: Progress -> ProgressCallback -> IO ()
@@ -227,42 +227,42 @@ any adjustment in totalUnits to the parents, whose callbacks /will/ be
 called.
 
 This ensures that the total expected counts on the parent are always correct.
-Without doing this, if, say, a transfer ended earlier than expected, ETA 
+Without doing this, if, say, a transfer ended earlier than expected, ETA
 values on the parent would be off since it would be expecting more data than
 actually arrived. -}
 finishP :: Progress -> IO ()
 finishP (Progress mp) =
     modifyMVar_ mp modfunc
     where modfunc :: ProgressRecord -> IO ProgressRecord
           modfunc oldpr =
-              do let adjustment = (completedUnits . status $ oldpr) 
+              do let adjustment = (completedUnits . status $ oldpr)
                                   - (totalUnits . status $ oldpr)
                  callParents oldpr (\x -> incrTotal x adjustment)
-                 return $ oldpr {status = (status oldpr) 
+                 return $ oldpr {status = (status oldpr)
                                  {totalUnits = completedUnits . status $ oldpr}}
 
 ----------------------------------------------------------------------
 -- Updating
 ----------------------------------------------------------------------
 {- | Increment the completed unit count in the 'Progress' object
 by the amount given.  If the value as given exceeds the total, then
-the total will also be raised to match this value so that the 
+the total will also be raised to match this value so that the
 completed count never exceeds the total.
 
 You can decrease the completed unit count by supplying a negative number
 here. -}
 incrP :: Progress -> Integer -> IO ()
 incrP po count = modStatus po statusfunc
-    where statusfunc s = 
+    where statusfunc s =
              s {completedUnits = newcu s,
                 totalUnits = if newcu s > totalUnits s
                                  then newcu s
                                  else totalUnits s}
-          newcu s = completedUnits s + count                  
+          newcu s = completedUnits s + count
 
 {- | Like 'incrP', but never modify the total. -}
 incrP' :: Progress -> Integer -> IO ()
-incrP' po count = 
+incrP' po count =
     modStatus po (\s -> s {completedUnits = completedUnits s + count})
 
 {- | Set the completed unit count in the 'Progress' object to the specified
@@ -283,10 +283,10 @@ setP' :: Progress -> Integer -> IO ()
 setP' po count = modStatus po (\s -> s {completedUnits = count})
 
 {- | Increment the total unit count in the 'Progress' object by the amount
-given.  This would rarely be needed, but could be needed in some special cases 
+given.  This would rarely be needed, but could be needed in some special cases
 when the total number of units is not known in advance. -}
 incrTotal :: Progress -> Integer -> IO ()
-incrTotal po count = 
+incrTotal po count =
     modStatus po (\s -> s {totalUnits = totalUnits s + count})
 
 {- | Set the total unit count in the 'Progress' object to the specified
@@ -318,26 +318,26 @@ that it can take either a 'Progress' or a 'ProgressStatus' object, and returns
 a number that is valid as any Fractional type, such as a Double, Float, or
 Rational. -}
 getSpeed :: (ProgressStatuses a (IO b), Fractional b) => a -> IO b
-getSpeed po = withStatus po $ \status -> 
+getSpeed po = withStatus po $ \status ->
                 do t <- timeSource status
                    let elapsed = t - (startTime status)
                    return $ if elapsed == 0
                        then fromRational 0
                        else fromRational ((completedUnits status) % elapsed)
 
-{- | Returns the estimated time remaining, in standard time units. 
+{- | Returns the estimated time remaining, in standard time units.
 
 Returns 0 whenever 'getSpeed' would return 0.
 
 See the comments under 'getSpeed' for information about this function's type
 and result. -}
 getETR :: (ProgressStatuses a (IO Integer),
            ProgressStatuses a (IO Rational)) => a -> IO Integer
-getETR po = 
+getETR po =
     do speed <- ((getSpeed po)::IO Rational)
        if speed == 0
           then return 0
-          else 
+          else
               -- FIXME: potential for a race condition here, but it should
               -- be negligible
               withStatus po $ \status ->
@@ -376,7 +376,7 @@ modStatus :: Progress -> (ProgressStatus -> ProgressStatus) -> IO ()
 modStatus (Progress mp) func =
     modifyMVar_ mp modfunc
     where modfunc :: ProgressRecord -> IO ProgressRecord
-          modfunc oldpr = 
+          modfunc oldpr =
               do let newpr = oldpr {status = func (status oldpr)}
                  mapM_ (\x -> x (status oldpr) (status newpr))
                            (callbacks oldpr)
@@ -394,4 +394,3 @@ modStatus (Progress mp) func =
 
 callParents :: ProgressRecord -> (Progress -> IO ()) -> IO ()
 callParents pr func = mapM_ func (parents pr)
-

src/Data/Quantity.hs

@@ -12,7 +12,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2006-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 Tools for rendering sizes

src/Data/String/Utils.hs

@@ -13,7 +13,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2004-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 This module provides various helpful utilities for dealing with strings.

src/Data/Tuple/Utils.hs

@@ -12,7 +12,7 @@ For license and copyright information, see the file LICENSE
    Copyright  : Copyright (C) 2004-2011 John Goerzen
    SPDX-License-Identifier: BSD-3-Clause
 
-   Stability  : provisional
+   Stability  : stable
    Portability: portable
 
 This module provides various helpful utilities for dealing with tuples.