Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make invariant for lazy ByteString visible in haddock #695

Open
Bodigrim opened this issue Oct 3, 2024 · 0 comments
Open

Make invariant for lazy ByteString visible in haddock #695

Bodigrim opened this issue Oct 3, 2024 · 0 comments

Comments

@Bodigrim
Copy link
Contributor

Bodigrim commented Oct 3, 2024

data ByteString = Empty | Chunk {-# UNPACK #-} !S.StrictByteString ByteString
-- INVARIANT: The S.StrictByteString field of any Chunk is not empty.
-- (See also the 'invariant' and 'checkInvariant' functions.)
-- To make testing of this invariant convenient, we add an
-- assertion to that effect when the HS_BYTESTRING_ASSERTIONS
-- preprocessor macro is defined, by renaming the actual constructor
-- and providing a pattern synonym that does the checking:

This should really be a haddock-visible documentation for Chunk constructor instead of source-only comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant