Opened 4 years ago

Closed 3 years ago

#15728 closed Bug (wontfix)

1.3 release notes should mention snafu regarding model form help_text formatting

Reported by: dchandek Owned by: nobody
Component: Documentation Version: 1.3
Severity: Normal Keywords:
Cc: dchandek Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

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:1 Changed 4 years ago by lukeplant

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Resolution set to invalid
  • Status changed from new to closed

Django 1.2.5 does not include this because it is a feature and features are not backported.

And the docs you linked to show the correct information (compare with the 1.2 docs).

So, everything seems to be in order, and was in order by the time 1.3 release was made. Please re-open if there is something I have misunderstood or overlooked.

Thanks!

comment:2 Changed 4 years ago by dchandek

  • Resolution invalid deleted
  • Severity set to Normal
  • Status changed from closed to reopened
  • Type set to Uncategorized

I did not mean to imply that the feature *should* have been in Django 1.2.5; the main points are: the 1.3 release notes do not mention the change; and, the doc currently on the site is, I'm afraid, wrong regarding help_text rendering.

The doc shows the f.as_table() printing help_text this way:

<br />A valid email address, please.

See http://code.djangoproject.com/browser/django/trunk/docs/ref/forms/fields.txt#L217.

However, the source code from 1.3 clearly shows the <span> wrapper -- see http://code.djangoproject.com/browser/django/tags/releases/1.3/django/forms/forms.py#L216 -- and the documentation was fixed in r15396. I don't know how these changes get applied to the live site, I'm just trying to help out here.

(I originally referred specifically to *model* forms, but both Form and ModelForm classes inherit the behavior from BaseForm.)

comment:3 Changed 4 years ago by dchandek

  • Cc dchandek added

comment:4 Changed 4 years ago by lukeplant

  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Uncategorized to Bug

Ah, the first line is correct (it has the span wrapper), the third line is incorrect, we were obviously looking at different bits. Accepted on that basis.

I really don't see the need for this to be in the release notes - it is a very small feature, without any complications, and there are (probably) many other small features like that not mentioned in the release notes. The docs should probably include a 'Changed in Django 1.3' admonition to note the addition of the span, but that is all.

comment:5 Changed 4 years ago by aaugustin

  • UI/UX unset

Change UI/UX from NULL to False.

comment:6 Changed 4 years ago by aaugustin

  • Easy pickings unset

Change Easy pickings from NULL to False.

comment:7 Changed 3 years ago by timo

  • Resolution set to wontfix
  • Status changed from reopened to closed

We'll be removing "Changed in Django 1.3" annotations soon, so marking this as won't fix.

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