Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation in Universum.Lifted.File to mention correct module #215

Merged
merged 1 commit into from
Aug 2, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ Unreleased
This may change semantics in some corner cases
(because `toString . toText` is not strictly the identity function).

* [#215](https:/serokell/universum/pull/215):
Fix docstrings in `Universum.Lifted.File` to mention correct module when
referencing related functions.

1.5.0
=====

Expand Down
8 changes: 4 additions & 4 deletions src/Universum/Lifted/File.hs
Original file line number Diff line number Diff line change
Expand Up @@ -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 #-}
Expand Down