Use the strict/lazy type synonyms for better generated documentation - #628
Merged
Conversation
Member
|
This indeed looks clearer! I envy the beginner who will learn Haskell with this change. :) |
Bodigrim
approved these changes
Nov 26, 2023
Contributor
Author
|
@Bodigrim The issue with doing that is that |
clyring
reviewed
Nov 26, 2023
clyring
left a comment
clyring
left a comment
Member
There was a problem hiding this comment.
Fantastic! I've wanted to do this for some time but never got around to it. I have a couple of very minor formatting questions/suggestions.
Thanks for doing this!
Replace confusing occurrences of strict/lazy ByteString in generated documentation with the corresponding type synonyms.
MorrowM
force-pushed
the
use-type-synonyms
branch
from
November 26, 2023 22:47
45e4a55 to
fd28083
Compare
Contributor
Author
|
@clyring Thanks for the catches, I think I've fixed them all. |
clyring
pushed a commit
that referenced
this pull request
Jan 30, 2024
Replace confusing occurrences of strict/lazy ByteString in generated documentation with the corresponding type synonyms. (cherry picked from commit 7e11412)
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
While using qualified names such as
S.ByteStringorL.ByteStringallows for GHC to disambiguate between the strict and lazy variants, the
generated haddocks end up being quite confusing, prime examples being
fromStrictandtoStrict.This patch replaces such uses with the type synonyms
StrictByteStringandLazyByteStringto (hopefully) make the docs a bit clearer.