#21858 closed Bug (fixed)
Clarify 1.6 release notes regarding ManyToManyField help_text
Reported by: | Owned by: | nobody | |
---|---|---|---|
Component: | Documentation | Version: | 1.6 |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
I just upgraded my app to 1.6 and am seeing instances of "Hold down "Control", or "Command" on a Mac, to select more than one." everywhere I use a a ModelMultipleChoiceField, even though the docs explicitly say this text isn't supposed to be added anymore. I also see code to do this, here:
https://github.com/django/django/blob/stable/1.6.x/django/forms/models.py#L1166-L1168
The release notes read:
HTML rendering of model form fields corresponding to ManyToManyField ORM model fields used to get the hard-coded sentence Hold down “Control”, or “Command” on a Mac, to select more than one. (or its translation to the active locale) imposed as the help legend shown along them if neither model nor form help_text attribute was specified by the user (or appended to, if help_text was provided.) This happened always, possibly even with form fields implementing user interactions that don’t involve a keyboard and/or a mouse and was handled at the model field layer. Starting with Django 1.6 this doesn’t happen anymore.
Attachments (1)
Change History (8)
comment:1 by , 11 years ago
comment:2 by , 11 years ago
Thanks for the response. It's pretty unclear from the text as to when exactly it "doesn't happen anymore", so I'm not sure what to suggest as to a revision.
My app was previously on 1.5, and in 1.5 this text didn't appear, and then it reappeared when I upgraded to 1.6, which makes it even more confusing as to what's going on.
comment:3 by , 11 years ago
Component: | Uncategorized → Documentation |
---|---|
Summary: | Text automatically added to Many-to-Many fields in 1.6 → Clarify 1.6 release notes regarding ManyToManyField help_text |
Triage Stage: | Unreviewed → Accepted |
Type: | Uncategorized → Bug |
by , 11 years ago
Attachment: | 21858.diff added |
---|
comment:4 by , 11 years ago
Has patch: | set |
---|
I had a chance to look at this when I did the deprecation removals for 1.8. Could you let me know if the attached patch clarifies the situation for you?
comment:5 by , 11 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
I think you need to read until the end of the section: "as an ad-hoc temporary backward-compatibility provision, the described non-standard behavior has been preserved but moved to the model form field layer and occurs only when the associated widget is SelectMultiple or selected subclasses."
Perhaps the documentation could be clarified with respect to exactly what "doesn't happen anymore." If you have any suggestions, I'd be happy to review the text and/or patch.