From f62b978b96d4422e429b67008f4a225a7a7d94a7 Mon Sep 17 00:00:00 2001 From: Serhii Pererva Date: Mon, 22 Jul 2019 22:01:21 +0100 Subject: [PATCH] [#215] Fix documentation in Universum.Lifted.File --- CHANGES.md | 4 +++- src/Universum/Lifted/File.hs | 8 ++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 8dab555..aa8a53a 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -6,11 +6,13 @@ Unreleased from the list of changes suggested in `.hlint.yaml`. * [#214](https://github.com/serokell/universum/issues/214): Update supported GHC versions (replace 7.10.3 with 8.6.5). - * [#212](https://github.com/serokell/universum/issues/212) Added rewrite rule for `toString . toText` case. This may change semantics in some corner cases (because `toString . toText` is not strictly the identity function). +* [#215](https://github.com/serokell/universum/pull/215): + Fix docstrings in `Universum.Lifted.File` to mention correct module when + referencing related functions. 1.5.0 ===== diff --git a/src/Universum/Lifted/File.hs b/src/Universum/Lifted/File.hs index 9d6b9af..02a8d1b 100644 --- a/src/Universum/Lifted/File.hs +++ b/src/Universum/Lifted/File.hs @@ -28,22 +28,22 @@ import qualified System.IO as XIO (openFile, hClose, IO) -- Text ---------------------------------------------------------------------------- --- | Lifted version of 'Data.Text.appendFile'. +-- | Lifted version of 'Data.Text.IO.appendFile'. appendFile :: MonadIO m => FilePath -> Text -> m () appendFile a b = liftIO (XIO.appendFile a b) {-# INLINE appendFile #-} --- | Lifted version of 'Data.Text.getLine'. +-- | Lifted version of 'Data.Text.IO.getLine'. getLine :: MonadIO m => m Text getLine = liftIO XIO.getLine {-# INLINE getLine #-} --- | Lifted version of 'Data.Text.readFile'. +-- | Lifted version of 'Data.Text.IO.readFile'. readFile :: MonadIO m => FilePath -> m Text readFile a = liftIO (XIO.readFile a) {-# INLINE readFile #-} --- | Lifted version of 'Data.Text.writeFile'. +-- | Lifted version of 'Data.Text.IO.writeFile'. writeFile :: MonadIO m => FilePath -> Text -> m () writeFile a b = liftIO (XIO.writeFile a b) {-# INLINE writeFile #-}