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

Fix ZSTD_estimate* and ZSTD_initCStream() docs #3448

Merged
merged 1 commit into from
Jan 23, 2023
Merged

Fix ZSTD_estimate* and ZSTD_initCStream() docs #3448

merged 1 commit into from
Jan 23, 2023

Conversation

embg
Copy link
Contributor

@embg embg commented Jan 23, 2023

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

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
@embg embg merged commit 41682e6 into dev Jan 23, 2023
@Cyan4973 Cyan4973 deleted the embg-doc-fix branch January 26, 2023 22:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants