chore: Add comprehensive documentation for hGetChunk (#651)#655
Merged
Lysxia merged 4 commits intohaskell:masterfrom Sep 20, 2025
Merged
chore: Add comprehensive documentation for hGetChunk (#651)#655Lysxia merged 4 commits intohaskell:masterfrom
hGetChunk (#651)#655Lysxia merged 4 commits intohaskell:masterfrom
Conversation
Contributor
|
Fine by me. @Bodigrim any thoughts? |
Bodigrim
reviewed
Sep 19, 2025
Bodigrim
reviewed
Sep 19, 2025
Co-authored-by: ˌbodʲɪˈɡrʲim <andrew.lelechenko@gmail.com>
Bodigrim
approved these changes
Sep 19, 2025
Lysxia
approved these changes
Sep 20, 2025
Contributor
|
Thanks @mchav ! |
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
3 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.
Summary
This PR adds detailed Haddock documentation for the
hGetChunkfunction to clarify its behavior regarding UTF-8 character boundaries and buffer limitations.Motivation
The existing documentation didn't clearly explain why
hGetChunkcannot guarantee reading an exact number of bytes. Users expecting byte-oriented behavior similar toByteString.hGetSomemay be confused by the character-oriented nature of Text operations.Changes
dEFAULT_CHAR_BUFFER_SIZE)