#16276 closed Cleanup/optimization (fixed)
Django 1.3 docs referring users to outdated version of Django Book
Reported by: | anonymous | Owned by: | bshaurette |
---|---|---|---|
Component: | Documentation | Version: | 1.3 |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | yes |
Easy pickings: | no | UI/UX: | no |
Description
In some places, the Django 1.3 docs refer to version 1.0 of the Django book, based on Django 0.96, rather than version 2.0 of the book. (Which is still only written against Django 1.1, but is the current release)
For example, https://docs.djangoproject.com/en/1.3/topics/auth/#storing-additional-information-about-users includes a line which says "For more information, see Chapter 12 of the Django book. http://www.djangobook.com/en/1.0/chapter12/#cn222"
Attachments (2)
Change History (7)
comment:1 by , 13 years ago
Triage Stage: | Unreviewed → Accepted |
---|---|
Type: | Bug → Cleanup/optimization |
comment:2 by , 13 years ago
Owner: | changed from | to
---|
by , 13 years ago
Attachment: | 16276.diff added |
---|
comment:3 by , 13 years ago
Has patch: | set |
---|
The warning notice mentioned in the previous comment appeared to have been added already, I've just made it a little more specific.
comment:4 by , 13 years ago
Patch needs improvement: | set |
---|
It looks pretty good, thanks! Just a few comments:
- please generate your patch from the root of the source tree.
- Keep the text PEP8-compliant by not stretching beyond 79 characters per line.
- Use a cross-reference for modpython:
:doc:`mod_python </howto/deployment/modpython>`
Thank you!
by , 13 years ago
Attachment: | 16276_djangobook_docs.diff added |
---|
The reference in
docs/topics/auth.txt
is already removed by the patch in #16207. The only other reference to the book (v2.0, chapter 12) is indocs/howto/deployment/index.txt
.It doesn't really hurt to leave it there as the chapter 12 of the book (v2.0) does contain thorough and still relevant information. In fact, most of the information in there is about third-party elements of the deployment stack and it is quite independent from any version of Django. So a warning notice inside the "see also" section of
docs/howto/deployment/index.txt
would be enough. It might also be considered to merge some relevant bits from the book to the official documentation.