[Django] #33198: BinaryField documentation references length in characters, which is incorrect

17 views
Skip to first unread message

Django

unread,
Oct 14, 2021, 4:45:21 PM10/14/21
to django-...@googlegroups.com
#33198: BinaryField documentation references length in characters, which is
incorrect
-----------------------------------------+------------------------
Reporter: Gavin Wahl | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 3.2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------
From the BinaryField documentation:

{{{
.. attribute:: BinaryField.max_length

The maximum length (in characters) of the field. The maximum length is
enforced in Django's validation using
:class:`~django.core.validators.MaxLengthValidator`.
}}}

BinaryFields do not store characters, they store bytes. It should be 'The
maximum length (in bytes) of the field'

--
Ticket URL: <https://code.djangoproject.com/ticket/33198>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Oct 15, 2021, 12:56:23 AM10/15/21
to django-...@googlegroups.com
#33198: BinaryField documentation references length in characters, which is
incorrect
-------------------------------+------------------------------------

Reporter: Gavin Wahl | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 3.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+------------------------------------
Changes (by Mariusz Felisiak):

* easy: 0 => 1
* stage: Unreviewed => Accepted


--
Ticket URL: <https://code.djangoproject.com/ticket/33198#comment:1>

Django

unread,
Oct 16, 2021, 7:31:13 AM10/16/21
to django-...@googlegroups.com
#33198: BinaryField documentation references length in characters, which is
incorrect
-------------------------------+----------------------------------------
Reporter: Gavin Wahl | Owner: Nick Frazier
Type: Bug | Status: assigned
Component: Documentation | Version: 3.2

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+----------------------------------------
Changes (by Nick Frazier):

* owner: nobody => Nick Frazier
* status: new => assigned


Comment:

Will submit a PR for this later today.

--
Ticket URL: <https://code.djangoproject.com/ticket/33198#comment:2>

Django

unread,
Oct 16, 2021, 5:37:03 PM10/16/21
to django-...@googlegroups.com
#33198: BinaryField documentation references length in characters, which is
incorrect
-------------------------------+----------------------------------------
Reporter: Gavin Wahl | Owner: Nick Frazier
Type: Bug | Status: assigned
Component: Documentation | Version: 3.2

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+----------------------------------------
Changes (by Nick Frazier):

* has_patch: 0 => 1


Comment:

[https://github.com/django/django/pull/15001 PR]

--
Ticket URL: <https://code.djangoproject.com/ticket/33198#comment:3>

Django

unread,
Oct 18, 2021, 2:24:17 AM10/18/21
to django-...@googlegroups.com
#33198: BinaryField documentation references length in characters, which is
incorrect
-------------------------------+----------------------------------------
Reporter: Gavin Wahl | Owner: Nick Frazier
Type: Bug | Status: closed
Component: Documentation | Version: 3.2
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+----------------------------------------
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"0d4e575c96d408e0efb4dfd0cbfc864219776950" 0d4e575c]:
{{{
#!CommitTicketReference repository=""
revision="0d4e575c96d408e0efb4dfd0cbfc864219776950"
Fixed #33198 -- Corrected BinaryField.max_length docs.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/33198#comment:4>

Django

unread,
Oct 18, 2021, 2:24:31 AM10/18/21
to django-...@googlegroups.com
#33198: BinaryField documentation references length in characters, which is
incorrect
-------------------------------+----------------------------------------
Reporter: Gavin Wahl | Owner: Nick Frazier
Type: Bug | Status: closed
Component: Documentation | Version: 3.2

Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+----------------------------------------

Comment (by Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"f5fd03aebe54f28a62436ef81aeed50fef594619" f5fd03ae]:
{{{
#!CommitTicketReference repository=""
revision="f5fd03aebe54f28a62436ef81aeed50fef594619"
[4.0.x] Fixed #33198 -- Corrected BinaryField.max_length docs.

Backport of 0d4e575c96d408e0efb4dfd0cbfc864219776950 from main
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/33198#comment:5>

Django

unread,
Oct 18, 2021, 2:25:01 AM10/18/21
to django-...@googlegroups.com
#33198: BinaryField documentation references length in characters, which is
incorrect
-------------------------------+----------------------------------------
Reporter: Gavin Wahl | Owner: Nick Frazier
Type: Bug | Status: closed
Component: Documentation | Version: 3.2

Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+----------------------------------------

Comment (by Mariusz Felisiak <felisiak.mariusz@…>):

In [changeset:"fdc1c6435c8fb9e720169ef0aebf87c33f1d86c2" fdc1c64]:
{{{
#!CommitTicketReference repository=""
revision="fdc1c6435c8fb9e720169ef0aebf87c33f1d86c2"
[3.2.x] Fixed #33198 -- Corrected BinaryField.max_length docs.

Backport of 0d4e575c96d408e0efb4dfd0cbfc864219776950 from main
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/33198#comment:6>

Reply all
Reply to author
Forward
0 new messages