Improve context processor documentation
|Reported by:||shacker||Owned by:||Kevin Kubasik|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||yes|
The answer to the common question "How do I make variables globally available to my templates?" is "context processors," which are covered at http://www.djangoproject.com/documentation/templates_python/ . But a new developer looking for an answer to this question will never find it in the docs by searching for "global" or "global variables." The documentation is there, but very difficult to find by searching on terms related to the problem. No new developer will know to search for "context processors."
Once the right section of the documentation is found, under the cryptic title "Subclassing Context: RequestContext," implementing the code samples on that page will only yield exception errors like "global name 'RequestContext' is not defined." Which means absolutely nothing (in terms of the fix) to the new Django developer. The code samples on that page should state that you need to:
from django.template import RequestContext
To promote Django acceptance, make learning the system less painful. Be specific, come up with a tagging system for the documentation to lead new developers to the right spot in the docs, and provide complete implementation details everywhere.
Change History (7)
comment:3 Changed 8 years ago by
|Owner:||changed from nobody to Kevin Kubasik|
comment:4 Changed 8 years ago by
|Patch needs improvement:||set|
|Summary:||Global variables documentation (context processors) → Improve context processor documentation|
|Triage Stage:||Ready for checkin → Accepted|