From 30ba506e978b31e16676b8da7b5e6cd8b4c4d8d4 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Sat, 29 Mar 2014 10:17:19 -0400 Subject: [PATCH] [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 --- docs/releases/1.6.txt | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/docs/releases/1.6.txt b/docs/releases/1.6.txt index d1fa6e41b65..804787e2f61 100644 --- a/docs/releases/1.6.txt +++ b/docs/releases/1.6.txt @@ -642,21 +642,24 @@ Help text of model form fields for ManyToManyField fields ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ HTML rendering of model form fields corresponding to -:class:`~django.db.models.ManyToManyField` ORM model fields used to get the -hard-coded sentence +:class:`~django.db.models.ManyToManyField` 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 :attr:`model ` nor :attr:`form -` ``help_text`` attribute was specified by the -user (or appended to, if ``help_text`` was provided.) +` ``help_text`` attributes were specified by the +user (or this string was appended to any ``help_text`` that 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. +Since this happened at the model layer, there was no way to prevent the text +from appearing in cases where it wasn't applicable such as form fields that +implement user interactions that don't involve a keyboard and/or a mouse. -Starting with Django 1.6 this doesn't happen anymore. +Starting with Django 1.6, as an ad-hoc temporary backward-compatibility +provision, the logic to add the "Hold down..." sentence has been moved to the +model form field layer and modified to add the text only when the associated +widget is :class:`~django.forms.SelectMultiple` or selected subclasses. The change can affect you in a backward incompatible way if you employ custom model form fields and/or widgets for ``ManyToManyField`` model fields whose UIs @@ -669,11 +672,6 @@ facilities together with Django built-in form :doc:`fields ` and :doc:`widgets ` aren't affected but need to be aware of what's described in :ref:`m2m-help_text-deprecation` below. -This is because, 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 -:class:`~django.forms.SelectMultiple` or selected subclasses. - QuerySet iteration ~~~~~~~~~~~~~~~~~~