Clarify benchmark chunking docstring #3197
Merged
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.
I spoke with a user today who thought
-B#
controls the zstd block size in benchmarks, rather than controlling the chunk size (to split a large compression into many independent small compressions). This leads to severe misinterpretation of results, because the latter interpretation affects compression ratio very differently than the former. I think the proposed doc update can prevent this misunderstanding going forward.