Tiny improvements in the Zlib documentation #682
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I think the first paragraph and last chunk should be left alone, the minimum compression is still 0, but there's a special value now for "let zlib decide" (-1). |
|
… we should probably remove the values from the constant list too, there's no need to explain what they are as zlib may change their values at will (as with the value of default compression). |
Remove the constant values as they may change in the future and add a link to the actual values that is more up-to-date than our documentation anyway. Also remove the mention about the default value as it may change again in the future.
robin850
changed the title
|
Thanks for the quick feedback @drbrain! The values are removed from the list but I've took the liberty to add a link to the actual values. I've removed the default value from the last chunk as this is wrong anyway. Let me know if I should update anything else. :-) |
mmasaki
pushed a commit
to mmasaki/ruby
that referenced
this pull request
Aug 10, 2014
they may change in the implementation without notice. Patched by @robin850 [Fixes rubyGH-682] ruby#682 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@46976 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
hsbt
pushed a commit
to ruby/zlib
that referenced
this pull request
Apr 14, 2017
they may change in the implementation without notice. Patched by @robin850 [Fixes GH-682] ruby/ruby#682 git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@46976 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello,
This pull request removes the constant values as they may change in the future and add a link to the actual values that is more up-to-date than our documentation anyway.
Also remove the mention about the default value as it may change again in the future.
Have a nice day.