Commit 0acab11d by Chris Jerdonek

Updates to template_spec docstrings.

parent 4d8d41bb
# coding: utf-8
"""
This module supports specifying custom template information per view.
This module supports customized (or special/specified) template loading.
"""
......@@ -13,21 +13,24 @@ from .locator import Locator
from .renderer import Renderer
# TODO: finish the class docstring.
class TemplateSpec(object):
"""
A mixin for specifying custom template information.
A mixin or interface for specifying custom template information.
Subclass this class only if template customizations are needed.
The "spec" in TemplateSpec can be taken to mean that the template
information is either "specified" or "special."
The following attributes allow one to customize/override template
information on a per View basis. A None value means to use default
behavior and perform no customization. All attributes are initially
set to None.
A view should subclass this class only if customized template loading
is needed. The following attributes allow one to customize/override
template information on a per view basis. A None value means to use
default behavior for that value and perform no customization. All
attributes are initialized to None.
Attributes:
template: the template to use, as a unicode string.
template: the template as a string.
template_rel_path: the path to the template file, relative to the
directory containing the module defining the class.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment