fix: correct auto-grade adjustment bounds in docstrings#90
Open
AGRO-CODEX wants to merge 1 commit into
Open
Conversation
The module and function docstrings claimed all adjustments were capped at +-8%, but gamma is actually bounded to [0.94, 1.10] (+10%/-6%) while contrast is [0.94, 1.08] and saturation is [0.94, 1.06]. Updated both docstrings to reflect the real per-axis bounds.
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
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.
What
Corrects two docstrings in
helpers/grade.pythat claimed auto-grade adjustments are "capped at +-8% on any axis." The actual bounds differ per axis.Why
The real clamps in
auto_grade_for_clipare:Gamma can go up to +10% for underexposed clips, not +8%. The module-level docstring and the
auto_grade_for_clipdocstring both stated "+-8%" which is misleading — a reader checking the docs before tuning the caps would see the wrong range.Changes
auto_grade_for_clipdocstring: same correction.No logic changes.
Summary by cubic
Update module and
auto_grade_for_clipdocstrings to state the real per-axis bounds for auto-grade adjustments: contrast ±8%, gamma +10%/-6%, saturation ±6%. Fixes the misleading “±8% on any axis” wording; no behavior changes.Written for commit e1375ad. Summary will update on new commits.