Skip to content

Commit

Permalink
Merge pull request #4202 from nhz2/fix-compressBound-typo
Browse files Browse the repository at this point in the history
Fix typo in ZSTD_compressBound docs
  • Loading branch information
Cyan4973 authored Nov 27, 2024
2 parents 7f11e6d + 10beb7c commit 2b36d4b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion lib/zstd.h
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ ZSTDLIB_API size_t ZSTD_findFrameCompressedSize(const void* src, size_t srcSize)
* it's recommended to provide @dstCapacity >= ZSTD_compressBound(srcSize)
* as it eliminates one potential failure scenario,
* aka not enough room in dst buffer to write the compressed frame.
* Note : ZSTD_compressBound() itself can fail, if @srcSize > ZSTD_MAX_INPUT_SIZE .
* Note : ZSTD_compressBound() itself can fail, if @srcSize >= ZSTD_MAX_INPUT_SIZE .
* In which case, ZSTD_compressBound() will return an error code
* which can be tested using ZSTD_isError().
*
Expand Down

0 comments on commit 2b36d4b

Please sign in to comment.