Fix outdated documentation for wrappedWithRunInIO
#72
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment that inspired this change: <#55 (comment)> Previously, you were unable to derive `MonadUnliftIO` using the `newtype` strategy because `askUnliftIO` was a method of the typeclass ([related issue](#55)). The `wrappedWithRunInIO` function is provided to help write instances of `MonadUnliftIO` for newtypes. In `unliftio-core` 0.2.0.0 and later, `askUnliftIO` was moved out of the `MonadUnliftIO` typeclass. This makes `wrappedWithRunInIO` irrelevant. This change deprecates that function, and updates the documentation to clarify that you can now write `deriving newtype (MonadUnliftIO)`.
snoyberg
reviewed
Apr 20, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Comment that inspired this change: #55 (comment)
Previously, you were unable to derive
MonadUnliftIOusing thenewtypestrategy becauseaskUnliftIOwas a method of the typeclass (related issue).The
wrappedWithRunInIOfunction is provided to help write instances ofMonadUnliftIOfor newtypes.In
unliftio-core0.2.0.0 and later,askUnliftIOwas moved out of theMonadUnliftIOtypeclass. This makeswrappedWithRunInIOirrelevant.This change deprecates that function, and updates the documentation to clarify that you can now write
deriving newtype (MonadUnliftIO).