[PATCH] Add deprecations status of unGetChan and isEmptyChan to Haddock comment

Ian Lynagh igloo at earth.li
Tue Aug 9 16:38:43 CEST 2011


Hi Simon,

On Tue, Aug 09, 2011 at 04:12:26PM +0200, Simon Hengel wrote:
> 
> diff --git a/Control/Concurrent/Chan.hs b/Control/Concurrent/Chan.hs
>  
> --- |Put a data item back onto a channel, where it will be the next item read.
> +-- |Note: This operation is deprecated.
> +-- If you need this operation, use "Control.Concurrent.STM.TChan" instead.  See
> +-- <http://hackage.haskell.org/trac/ghc/ticket/4154> for details.
> +--
> +-- Put a data item back onto a channel, where it will be the next item read.
>  unGetChan :: Chan a -> a -> IO ()
>  unGetChan (Chan readVar _) val = do
>     new_read_end <- newEmptyMVar
> @@ -118,7 +122,11 @@ unGetChan (Chan readVar _) val = do
>       return new_read_end
>  {-# DEPRECATED unGetChan "if you need this operation, use Control.Concurrent.STM.TChan instead.  See http://hackage.haskell.org/trac/ghc/ticket/4154 for details" #-}

Hmm, I agree the info should be in the docs, but I think it would be
better if haddock extracted the info from the pragma, rather than us
having to repeat ourselves all the time.


Thanks
Ian




More information about the Libraries mailing list