1.3 release notes should mention snafu regarding model form help_text formatting
|Reported by:||David Chandek-Stark||Owned by:||nobody|
|Cc:||David Chandek-Stark||Triage Stage:||Accepted|
|Has patch:||no||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
The documentation and source code release of the (good) change in which model forms render help_text strings wrapped in <span class="helptext"></span> elements is rather a mess. Ticket #8426 notes that the change was made "hopefully for real this time" in r13522. However, Django 1.2.5 (r15473) does *not* include this patch. Ticket #15204 fixing the documentation was closed (ready for checkin) nearly 2 months ago, but the docs (as of Thu Mar 31 11:00:00 EDT 2011) at http://docs.djangoproject.com/en/dev/ref/forms/fields/#help-text still show the wrong information.
I think it would be good to add a section to the 1.3 release notes (or perhaps a separate blog post) clarifying the situation. This was an important (if small) change in that I for one had taken care to work around the lack of a <span> wrapper in model form rendering by including the element directly in model field help_text, and am happy to know that that poor hack is no longer necessary.
Thanks for the consideration.
Change History (7)
comment:2 Changed 6 years ago by
|Status:||closed → reopened|