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.

Sign up for GitHub

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

Jump to bottom

Tiny improvements in the Zlib documentation #682

Closed
wants to merge 1 commit into from
Closed

Tiny improvements in the Zlib documentation #682

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 8 additions & 6 deletions ext/zlib/zlib.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1463,13 +1463,15 @@ rb_deflate_s_allocate(VALUE klass)
* the default value of that argument is used.
*
* The +level+ sets the compression level for the deflate stream between 0 (no
* compression) and 9 (best compression. The following constants have been
* compression) and 9 (best compression). The following constants have been
* defined to make code more readable:
*
* * Zlib::NO_COMPRESSION = 0
* * Zlib::BEST_SPEED = 1
* * Zlib::DEFAULT_COMPRESSION = 6
* * Zlib::BEST_COMPRESSION = 9
* * Zlib::DEFAULT_COMPRESSION
* * Zlib::NO_COMPRESSION
* * Zlib::BEST_SPEED
* * Zlib::BEST_COMPRESSION
*
* See http://www.zlib.net/manual.html#Constants for further information.
*
* The +window_bits+ sets the size of the history buffer and should be between
* 8 and 15. Larger values of this parameter result in better compression at
Expand Down Expand Up @@ -1591,7 +1593,7 @@ deflate_run(VALUE args)
*
* Compresses the given +string+. Valid values of level are
* Zlib::NO_COMPRESSION, Zlib::BEST_SPEED, Zlib::BEST_COMPRESSION,
* Zlib::DEFAULT_COMPRESSION, or an integer from 0 to 9 (the default is 6).
* Zlib::DEFAULT_COMPRESSION, or an integer from 0 to 9.
*
* This method is almost equivalent to the following code:
*
Expand Down