Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#33198 closed Bug (fixed)

BinaryField documentation references length in characters, which is incorrect

Reported by: Gavin Wahl Owned by: Nick Frazier
Component: Documentation Version: 3.2
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

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'

Change History (6)

comment:1 by Mariusz Felisiak, 3 years ago

Easy pickings: set
Triage Stage: Unreviewed → Accepted

comment:2 by Nick Frazier, 3 years ago

Owner: changed from nobody to Nick Frazier
Status: new → assigned

Will submit a PR for this later today.

comment:3 by Nick Frazier, 3 years ago

Has patch: set

​PR

comment:4 by Mariusz Felisiak <felisiak.mariusz@…>, 3 years ago

Resolution: → fixed
Status: assigned → closed

In 0d4e575c:

Fixed #33198 -- Corrected BinaryField.max_length docs.

comment:5 by Mariusz Felisiak <felisiak.mariusz@…>, 3 years ago

In f5fd03ae:

[4.0.x] Fixed #33198 -- Corrected BinaryField.max_length docs.

Backport of 0d4e575c96d408e0efb4dfd0cbfc864219776950 from main

comment:6 by Mariusz Felisiak <felisiak.mariusz@…>, 3 years ago

In fdc1c64:

[3.2.x] Fixed #33198 -- Corrected BinaryField.max_length docs.

Backport of 0d4e575c96d408e0efb4dfd0cbfc864219776950 from main

Note: See TracTickets for help on using tickets.
Back to Top