diff options
| author | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2014-07-27 19:41:22 +0000 |
|---|---|---|
| committer | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2014-07-27 19:41:22 +0000 |
| commit | e0270975d8d234c52500e8f085591801a26fe4c6 (patch) | |
| tree | a43a1144987e7a7bfa571be2e1d8a49324dbc28b /ext/zlib/zlib.c | |
| parent | 3a4ac27f7ec24ab7d338b110eba934f3f29fd583 (diff) | |
* ext/zlib/zlib.c: [DOC] Remove default value of Zlib constants, as
they may change in the implementation without notice. Patched by
@robin850 [Fixes GH-682] https://github.com/ruby/ruby/pull/682
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@46976 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/zlib/zlib.c')
| -rw-r--r-- | ext/zlib/zlib.c | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/ext/zlib/zlib.c b/ext/zlib/zlib.c index b323efab13..c253b94d95 100644 --- a/ext/zlib/zlib.c +++ b/ext/zlib/zlib.c @@ -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 @@ -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: * |