Code

Opened 5 years ago

Closed 5 years ago

Last modified 3 years ago

#10053 closed (fixed)

Incorrect pydoc in django.template.loaders.app_directories.load_template_source

Reported by: kylev Owned by: nobody
Component: Documentation Version: 1.0
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

The pydoc for this code is misleading:

"""
Wrapper for loading templates from "template" directories in INSTALLED_APPS
packages.
"""

In fact, the code builds the template path thusly:

template_dir = os.path.join(os.path.dirname(mod.__file__), 'templates')

Please fix the pydoc to say "templates/" as it will reduce frustration a little when building self-contained apps. It might also be useful to mention in tutorials that this functionality is in place by default, since it alleviates the need to fiddle with the project-wide TEMPLATE_DIRS setting.

Attachments (1)

django-templates-doc.patch (437 bytes) - added by kylev 5 years ago.
The most exciting patch you'll ever see.

Download all attachments as: .zip

Change History (5)

Changed 5 years ago by kylev

The most exciting patch you'll ever see.

comment:1 Changed 5 years ago by jacob

  • milestone set to 1.1
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 5 years ago by ericholscher

  • Component changed from Template system to Documentation
  • Triage Stage changed from Accepted to Ready for checkin

comment:3 Changed 5 years ago by jacob

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

Fixed in [10358].

comment:4 Changed 3 years ago by jacob

  • milestone 1.1 deleted

Milestone 1.1 deleted

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.