lzlib: Adjust 'lz-compress-read' docstring.

* guix/lzlib.scm (lz-compress-read): The integer return can be zero;
adjust docstring accordingly.
This commit is contained in:
Ludovic Courtès 2019-05-27 22:27:02 +02:00
parent 8916034a34
commit e13354a7ca
No known key found for this signature in database
GPG Key ID: 090B11993D9AEBB5
1 changed files with 1 additions and 1 deletions

View File

@ -168,7 +168,7 @@ so use it only when needed. "
(let ((proc (lzlib-procedure int "LZ_compress_read" (list '* '* int)))) (let ((proc (lzlib-procedure int "LZ_compress_read" (list '* '* int))))
(lambda* (encoder lzfile-bv #:optional (start 0) (count (bytevector-length lzfile-bv))) (lambda* (encoder lzfile-bv #:optional (start 0) (count (bytevector-length lzfile-bv)))
"Read up to COUNT bytes from the encoder stream, storing the results in LZFILE-BV. "Read up to COUNT bytes from the encoder stream, storing the results in LZFILE-BV.
Return the number of uncompressed bytes written, a strictly positive integer." Return the number of uncompressed bytes written, a positive integer."
(let ((ret (proc (lz-encoder->pointer encoder) (let ((ret (proc (lz-encoder->pointer encoder)
(bytevector->pointer lzfile-bv start) (bytevector->pointer lzfile-bv start)
count))) count)))