guetzli icon indicating copy to clipboard operation
guetzli copied to clipboard

Updated Readme.md to make quality parameter better documented.

Open Kiricon opened this issue 7 years ago • 7 comments

Added example of numbers that can be used for quality parameter and explained the current limit of numbers above the 83% quality threshold.

"equivalent to libjpeg quality" does not have inherent meaning to users without the context of the documentation.

Kiricon avatar Mar 22 '17 17:03 Kiricon

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

:memo: Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please let us know the company's name.

googlebot avatar Mar 22 '17 17:03 googlebot

I signed it!

Kiricon avatar Mar 22 '17 18:03 Kiricon

CLAs look good, thanks!

googlebot avatar Mar 22 '17 18:03 googlebot

"require modifying the code to go bellow the set threshold." - that can easily be interpreted as "require hacking the argument check to allow lower number" rather than "rewriting the compressor to tune it to lower values".

The check isn't there to annoy people and make them compile source with a lower number. It's there to stop people from wasting their time on using quality that this compressor isn't good at.

kornelski avatar Mar 22 '17 18:03 kornelski

@pornel That's a very great point I had not thought of. Is there by chance a way we can change that sentence so that we can still give a user heads up about the limit, and inform them that the compressor should not be bellow that threshold for the reasons you outlined? Or Perhaps we should remove that section from the read me and leave in the example "(0 - 100)"?

Kiricon avatar Mar 22 '17 20:03 Kiricon

Perhaps something like this:

You can pass a --quality Q parameter to set quality in units equivalent to libjpeg quality (84 - 100). Guetzli works best with high qualities. 84 is the lowest supported quality.

kornelski avatar Mar 22 '17 21:03 kornelski

@pornel Thanks for the example. I think that the wording is much more elegantly in these terms.

I updated my pull request to include the text in your example.

Thanks again for the feedback!

Kiricon avatar Mar 23 '17 01:03 Kiricon