Fix ZSTD_estimate* and ZSTD_initCStream() docs #3448
Merged
Conversation
This file contains 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
Fix the following documentation bugs: * Note that `ZSTD_estimate*` functions are not compatible with the external matchfinder API * Note that `ZSTD_estimateCStreamSize_usingCCtxParams()` is not compatible with `nbWorkers >= 1` * Remove incorrect warning that the legacy streaming API is incompatible with advanced parameters and/or dictionary compression * Note that `ZSTD_initCStream()` is incompatible with dictionary compression * Warn that
Cyan4973
approved these changes
Jan 23, 2023
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.
Fix the following documentation bugs:
ZSTD_estimate*functions are not compatible with the external matchfinder APIZSTD_estimateCStreamSize_usingCCtxParams()is not compatible withnbWorkers >= 1ZSTD_initCStream()is incompatible with dictionary compression