Opened 13 months ago

Closed 11 months ago

Last modified 11 months ago

#21858 closed Bug (fixed)

Clarify 1.6 release notes regarding ManyToManyField help_text

Reported by: lee@… 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)

21858.diff (2.5 KB) - added by timo 11 months ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 13 months ago by timo

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

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.

comment:2 Changed 13 months ago by anonymous

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 Changed 13 months ago by timo

  • Component changed from Uncategorized to Documentation
  • Summary changed from Text automatically added to Many-to-Many fields in 1.6 to Clarify 1.6 release notes regarding ManyToManyField help_text
  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Uncategorized to Bug

Changed 11 months ago by timo

comment:4 Changed 11 months ago by timo

  • 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 Changed 11 months ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from new to closed

In f30e6590f40c8b008cbe5833579fca4fd93ecc61:

Fixed #21858 -- Clarified 1.6 release note regarding M2M help text changes.

Thanks lee at semel.net for the report.

comment:6 Changed 11 months ago by Tim Graham <timograham@…>

In c139e3e0a0d190b9b06e0cf2ec0c0c409ca978c3:

[1.7.x] Fixed #21858 -- Clarified 1.6 release note regarding M2M help text changes.

Thanks lee at semel.net for the report.

Backport of f30e6590f4 from master

comment:7 Changed 11 months ago by Tim Graham <timograham@…>

In 30ba506e978b31e16676b8da7b5e6cd8b4c4d8d4:

[1.6.x] Fixed #21858 -- Clarified 1.6 release note regarding M2M help text changes.

Thanks lee at semel.net for the report.

Backport of f30e6590f4 from master

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