#23252: Better communication of features that will no longer be available in a
release
--------------------------------------+------------------------------------
Reporter: nick.phillips@… | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.7-rc-2
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by russellm):
* severity: Normal => Release blocker
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
* type: Uncategorized => Cleanup/optimization
* stage: Unreviewed => Accepted
Comment:
This is a valid point that a few people have made in the past. At the
core, the issue is that the release notes tell you what was deprecated in
*this* release, but doesn't contain any reference to what has reached the
end of it's deprecation cycle and will therefore no longer be available.
The information about what has been deprecated is still available - it's
just not contained in the document someone is reading when they're
upgrading. It isn't necessarily obvious that when you're reading the 1.7
release notes, you may also need to pay attention to the 1.5 release notes
(and possibly the 1.6 release notes as well for fast deprecation path) to
get the full picture.
This came up in an in-person discussion at PyCon AU; the suggestion made
there was a simple line in the 1.7 release notes, at the top of the
"deprecated features" section, that said something to the effect of:
"This release completes the deprecation cycle for features deprecated in
1.5 and 1.6:
* Removal of django.contrib.localflavor
* Removal of django.contrib.markup
* Removal of AUTH_PROFILE_MODULE
* Streaming behaviour of HttpResponse
* ...
"
with the bullet points being no more than a heading linking to the
relevant section in the 1.5/1.6 release notes, as appropriate.
Yes - this is duplication of information. Yes, this information should
have been obvious if you were listening to all the warnings generated when
you ran your project under 1.6. But yes, we're all human, and sometimes
ignore the big loud warning. It costs us very little to add this minor
redundancy in the docs, but the communication gains are large.
Marking as a release blocker because it should be addressed before the 1.7
release notes are finalised.
--
Ticket URL: <https://code.djangoproject.com/ticket/23252#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/083.4206ca22752df2a7a4a3a735f6be8118%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
