Fix incorrect usage of Encoder.Parameters in README#220
Merged
Conversation
Owner
|
Indeed it's a typo, it should be: Encoder.Parameters params = Encoder.Parameters.create(4);Can you use this instead? |
Contributor
Author
No. It says "The method create(int) is undefined for the type Encoder.Parameters" Brotli4j version: 1.18.0 |
Owner
Works fine though |
Contributor
Author
|
I don't know why but I don't have the static method create(int quality) inside the static class Parameters. |
Owner
|
the |
Contributor
Author
|
Even without new it doesn't change |
Owner
|
That's strange. Can you try it in a new environment? Maybe Github Codespaces? |
Contributor
Author
|
Same issue. |
Owner
|
Got it. See: #196 |
Owner
|
I will cut a new release soon. |
hyperxpro
reviewed
Jul 22, 2025
Owner
|
Thanks a lot! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation:
The current README contains an invalid example in the “Compressing a stream” section. It uses
new Encoder.Parameters.create(4);, which does not exist in the actual API.Modification:
I updated the README to replace:
with the correct, working usage:
Result:
Fixes incorrect documentation in the README.