pack should never raise XException
#3097
Open
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
DigitalBrains1
force-pushed
the
pack-no-xexception
branch
from
3b762e1 to
b39e528
Compare
It can be nice to be able to rely on `pack` never raising `XException` and it is good behavior. I have always expected this behavior, but it was not documented. Let's document it. I have checked all instances in `clash-prelude` and they all conform to the law. The same goes for deriving a `BitPack` or using `deriveBitPack`.
DigitalBrains1
force-pushed
the
pack-no-xexception
branch
from
b39e528 to
5f75eb5
Compare
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.
It can be nice to be able to rely on
packnever raisingXExceptionand it is good behavior. I have always expected this behavior, but it was not documented. Let's document it. I have checked all instances inclash-preludeand they all conform to the law. The same goes for deriving aBitPackor usingderiveBitPack.Still TODO:
Write a changelog entry (see changelog/README.md)I don't think this needs a changelog entry. It is more of a clarification than a change. But if people want a changelog, that can be done.