fixup: documentation

Author: harendra-kumar

core/src/Streamly/Internal/Control/Exception.hs

@@ -77,11 +77,11 @@ verifyM predicate = verify predicate (pure ())
 
 -- | @AllocateIO f@ is a newtype wrapper for an IO monad allocator function @f@.
 --
--- The allocator function @f alloc free@ is used in bracket style safe resource
--- allocation functions, where @alloc@ is function used to allocate a resource
--- and @free@ is used to free it. The allocator returns a tuple @(result,
--- release)@ where @result@ is the allocated resource and @release@ is an
--- action that can be called later to release the resource.
+-- The allocator function @f alloc free@ is used in bracket-style safe resource
+-- allocation functions, where @alloc@ is a function used to allocate a
+-- resource and @free@ is used to free it. The allocator returns a tuple
+-- @(resource, release)@ where @resource@ is the allocated resource and
+-- @release@ is an action that can be called later to release the resource.
 --
 newtype AllocateIO = AllocateIO
     (forall b c. IO b -> (b -> IO c) -> IO (b, IO ()))
@@ -108,13 +108,11 @@ newtype RegisterIO = RegisterIO (forall c. IO c -> IO ())
 -- resource manually at any time. @release@ is guaranteed to free the resource
 -- only once even if it is called concurrently or multiple times.
 --
--- This function provides functionality similar to the bracket function
+-- This function provides functionality similar to the @bracket@ function
 -- available in the base library. However, it is more powerful as any number of
 -- resources can be allocated at any time within the scope and can be released
 -- at any time.
 --
--- This function does not rely on GC for cleanup. Cleanup is deterministic.
---
 -- Exception safe, thread safe.
 {-# INLINE withAllocateIO #-}
 withAllocateIO :: (MonadIO m, MonadMask m) => (AllocateIO -> m a) -> m a
@@ -156,15 +154,13 @@ allocToRegIO (AllocateIO f) = RegisterIO (void . g)
 
 -- | @withRegisterIO action@ runs the given @action@, providing it with a
 -- special function called @register@ as argument. A @register hook@ call can
--- be used within @action@ any number of times to register a hook that would
--- run automatically when 'withAllocateIO' ends or if an exception occurs at
+-- be used within @action@ any number of times to register hooks that would
+-- run automatically when 'withRegisterIO' ends or if an exception occurs at
 -- any time.
 --
--- This function provides functionality similar to the finally function
--- available in the base library. However, it is more powerful as any number of
--- hooks can be registered at any time within the scope of @withRegisterIO@.
---
--- This function does not rely on GC for executing the hooks.
+-- This function provides functionality similar to the @finally@ function
+-- available in the @base@ package. However, it is more powerful as any number
+-- of hooks can be registered at any time within the scope of @withRegisterIO@.
 --
 -- Exception safe, thread safe.
 {-# INLINE withRegisterIO #-}