Document Loc #26
Merged
Document Loc #26
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
MaxGabriel
commented
Aug 12, 2020
|
Thanks for the quick merge, always really nice contributing to your packages :) |
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.
This PR is primarily inspired by yesodweb/persistent#1076. Persistent was importing
Locdirectly from template-haskell and unnecessarily depending on that package, causing issues for users.This PR documents what I think is the intended usage, importing
Locfrom monad-logger instead. Additionally, I think the documentation around Loc is good for even regular users, since it explains it's a re-export from template-haskell.I wasn't able to add documentation directly to
Locwith the standard-- |, I'm guessing becauseLocis a re-export. So I added the documentation directly above the export ofLoc.