#35284: PositiveIntegerField description is confusing
------------------------------------------------+------------------------
Reporter: Jon Ribbens | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 5.0
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 1
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------------+------------------------
In ticket:7609, the description for PositiveIntegerField was changed from
saying that its value "must be positive" to saying it "must be positive or
zero". This is clearly and unarguably an improvement. However the
following sentence was also added: "The value `0` is accepted for backward
compatibility reasons." This additional sentence is inaccurate and
confusing. I say "inaccurate" because zero isn't accepted for "backward
compatibility", it's accepted because that's the behaviour most people
want. I say "confusing" because it makes it sound like using the field to
store zeroes is somehow deprecated and likely to be changed in the future,
which as far as I can see is not the case. This completely unnecessarily
reduces peoples' confidence in using this field type. I suggest simply
removing that sentence.
--
Ticket URL: <https://code.djangoproject.com/ticket/35284>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/0107018e1eef71dd-29c96b3e-fee3-48d4-9d5b-3576958f70bc-000000%40eu-central-1.amazonses.com.
