doc: Refines documentation and API option descriptions#299
Merged
Conversation
Updates include: * Renaming the `checksum` option field to `checksum_enabled` in examples. * Clarifying which options (`n_threads`, progress callback) are ignored by the single-threaded `zxc_compress` and `zxc_decompress` calls. * Updating the maximum compression `level` from 5 to 6. * Specifying the "MAJOR.MINOR.PATCH" format for the library version string. * Clarifying that `n_threads` values exceeding `ZXC_MAX_THREADS` are clamped rather than resulting in an error.
Updates internal documentation to ensure accuracy: * Corrects the list of standard headers provided by `zxc_deps.h`, adding `CHAR_BIT` and removing `INT_MAX`/`UINT_MAX`. * Renames `hash_positions` to `hash_table` in hash table geometry descriptions. * Adjusts the maximum Huffman encoding bit code from 11 to 8 bits. * Clarifies the `epoch` storage description in the hash table from `(epoch << 16)` to `(epoch << offset_bits)`.
hellobertrand
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
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
1 participant
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.
Enhances clarity and accuracy across various documentation aspects:
checksum_enabledoption name and clarifying which options are utilized by single-threaded calls.ZXC_MAX_THREADSby indicating that higher values are clamped, rather than resulting in an error.