Opened 6 years ago

Closed 6 years ago

Last modified 5 years ago

#14600 closed (fixed)

No mentioning of addition of staticfiles to TEMPLATE_CONTEXT_PROCESSORS after 1.2 in settings documentation

Reported by: mathijs@… Owned by: nobody
Component: Documentation Version: master
Severity: Keywords: staticfiles context_processors documentation template_context_processors media
Cc: Brian Neal Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

In the devs docs, the list of TEMPLATE_CONTEXT_PROCESSORS is:

("django.contrib.auth.context_processors.auth",
"django.core.context_processors.debug",
"django.core.context_processors.i18n",
"django.contrib.staticfiles.context_processors.staticfiles",
"django.contrib.messages.context_processors.messages")

In the 1.2 docs, it reads:

("django.contrib.auth.context_processors.auth",
"django.core.context_processors.debug",
"django.core.context_processors.i18n",
"django.core.context_processors.media",
"django.contrib.messages.context_processors.messages")

Since "django.core.context_processors.media" changed for "django.contrib.staticfiles.context_processors.staticfiles" it should mention something about this in the docs. This way it's confusing for innocent users like myself.

A suggested change would be:

Changed in Django 1.3: "django.core.context_processors.media" was replaced by ""django.contrib.staticfiles.context_processors.staticfiles" in the default. For more information, see the staticfiles documentation.

Change History (4)

comment:1 Changed 6 years ago by Gabriel Hurley

Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset
Triage Stage: UnreviewedAccepted

comment:2 Changed 6 years ago by Brian Neal

Cc: Brian Neal added

There is also no mention that the new staticfiles context processor also puts MEDIA_URL in the context here. It is mentioned here, however there is a typo "This context processor has been moved to the new The staticfiles app app".

There is a typo here: "see the statcfiles reference."

comment:3 Changed 6 years ago by Gabriel Hurley

Resolution: fixed
Status: newclosed

(In [14479]) Fixed #14600 -- Added a versionchanged directive to the TEMPLATE_CONTEXT_PROCESSORS setting reference, and added a currentmodule directive to the staticfiles docs so that the crossref targets would point to the right place even with full paths in the staticfiles docs. Thanks to mathijs for the report and suggested text.

comment:4 Changed 5 years ago by Jacob

milestone: 1.3

Milestone 1.3 deleted

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