From e98ddd661265ea61b43c39fcfaecdb137de712e0 Mon Sep 17 00:00:00 2001 From: Eric Biggers Date: Sat, 10 Oct 2020 14:27:21 -0700 Subject: [PATCH] libdeflate.h: document invalid compression level error Somehow this was missing from the documentation. --- libdeflate.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/libdeflate.h b/libdeflate.h index 4e124e7..8626640 100644 --- a/libdeflate.h +++ b/libdeflate.h @@ -62,7 +62,8 @@ struct libdeflate_compressor; * DEFLATE, zlib, and gzip compression. 'compression_level' is the compression * level on a zlib-like scale but with a higher maximum value (1 = fastest, 6 = * medium/default, 9 = slow, 12 = slowest). The return value is a pointer to - * the new compressor, or NULL if out of memory. + * the new compressor, or NULL if out of memory or if the compression level is + * invalid (i.e. outside the range [1, 12]). * * Note: for compression, the sliding window size is defined at compilation time * to 32768, the largest size permissible in the DEFLATE format. It cannot be