Opened 4 years ago

Closed 3 years ago

Last modified 3 years ago

#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)

16276.diff (654 bytes) - added by bshaurette 3 years ago.
16276_djangobook_docs.diff (729 bytes) - added by bluejeansummer 3 years ago.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 4 years ago by julien

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Bug to Cleanup/optimization

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 in docs/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.

comment:2 Changed 3 years ago by bshaurette

  • Owner changed from nobody to bshaurette

Changed 3 years ago by bshaurette

comment:3 Changed 3 years ago by bshaurette

  • 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 Changed 3 years ago by julien

  • 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!

Changed 3 years ago by bluejeansummer

comment:5 Changed 3 years ago by julien

  • Resolution set to fixed
  • Status changed from new to closed

In [16802]:

Fixed #16276 -- Noted in the deployment documentation index that the Django Book 2nd ed. was written against Django 1.1. Thanks to bshaurette and bluejeansummer for the patch.

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