Opened 2 years ago
Closed 2 years ago
#34071 closed Cleanup/optimization (fixed)
Unclear validator messages for Range(Min/Max)ValueValidator compared to docs.
| Reported by: | Jack Linke | Owned by: | Jack Linke |
|---|---|---|---|
| Component: | contrib.postgres | Version: | dev |
| Severity: | Normal | Keywords: | postgres, range, validator, validators |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
The wording in the documentation for RangeMaxValueValidator and RangeMinValueValidator is very clear:
"Validates that the upper bound of the range is not greater than limit_value." "Validates that the lower bound of the range is not less than the limit_value."
The wording in the validator messages (and validator test messages) within the code itself is somewhat confusing in comparison:
"Ensure that this range is completely less than or equal to %(limit_value)s." "Ensure that this range is completely greater than or equal to %(limit_value)s."
https://github.com/django/django/blob/0dd29209091280ccf34e07c9468746c396b7778e/django/contrib/postgres/validators.py
https://github.com/django/django/blob/0dd29209091280ccf34e07c9468746c396b7778e/tests/postgres_tests/test_ranges.py
Recommending a patch to modify the messages in the validator (and validator test) code to match the documentation, making it more clear to users exactly what the range validators do.
Patch 16146 on Django's GitHub PR tracker should resolve this. https://github.com/django/django/pull/16146
Change History (3)
comment:1 by , 2 years ago
| Easy pickings: | set |
|---|---|
| Owner: | set to |
| Status: | new → assigned |
| Summary: | Unclear / mismatched validator messages in code for RangeMaxValueValidator & RangeMinValueValidator compared to docs → Unclear validator messages for Range(Min/Max)ValueValidator compared to docs. |
| Triage Stage: | Unreviewed → Accepted |
comment:2 by , 2 years ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
comment:3 by , 2 years ago
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
In 344d31c7: