Export DecompressError + Improve Documentation
#12
Conversation
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
It was missing from Codec.Compression.BZip.Internal.
Copied (and fixed) documentation from `zlib`, and also added some specific documentation to the fold functions. Also bumped version number and added details to changelog.
Fixed documentation of function arguments to use `-- ^` instead of `-- |`, since it should work with more versions of Haddock. Also added some examples to the `fold` argument of foldCompressStream/foldDecompressStream. Changed version number to be 0.5.3.0 instead of 0.5.2.1, since the change introduces a new export.
Bodigrim
reviewed
Dec 2, 2025
Contributor
|
Thanks, awesome! Do you need a release? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Functionally, this just adds
DecompressError(..)to the export list ofCodec.Compression.BZip.Internal, but it also addsa lot of documentation to the
Internalmodule from the corresponding functions from zlib. I also added some documentation for the arguments of thefoldCompressStream/etc... functions to improve clarity.Also, I bumped the version number and updated the changelog, which I suspect I wasn't supposed to? This is my first time contributing upstream to a Haskell package, so I wasn't sure of the protocol.