Conversation
for more information, see https://pre-commit.ci
p-sawicki
approved these changes
Apr 29, 2026
Comment on lines
+124
to
+125
| Read a 16-bit integer value starting at the given index as a little-endian binary value | ||
| (2 bytes). |
Collaborator
There was a problem hiding this comment.
mentioning it's 2 bytes seems redundant since we already mention it's a 16-bit integer. maybe remove it? same in other descriptions.
Collaborator
Author
There was a problem hiding this comment.
I added this to help users with less experience with low-level programming. In order to use the read functions correctly, the caller must increment the index with the correct number of bytes, and this makes the number a bit more explicit. It's kind of redundant, but on the other hand it's only two extra words per function.
JukkaL
added a commit
that referenced
this pull request
Apr 30, 2026
This is no longer hidden behind a feature flag, so document it.
Also document that `ord("x")` is treated as a compile-time constant
expression, as it's
related to some typical StringWriter use cases.
Enable links to Python stdlib docs, since they are useful here.
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
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.
This is no longer hidden behind a feature flag, so document it.
Also document that
ord("x")is treated as a compile-time constant expression, as it'srelated to some typical StringWriter use cases.
Enable links to Python stdlib docs, since they are useful here.