evin/secretary
3
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update Renderer docstring.

Browse source
This commit is contained in:
Christopher 2015-12-21 12:03:54 -06:00
parent 27448e6d64
commit 2a7128c9ab
1 changed files with 8 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

19
secretary.py
View file

@ -108,16 +108,15 @@ class Renderer(object):
compatible template. compatible template.
Basic use example: Basic use example:
engine = Renderer('template') engine = Renderer()
result = engine.render() result = engine.render(template, var1=val1, var2=val2, ...)
Renderer provides an enviroment variable which can be used Renderer provides an environment property which should be used
to provide custom filters to the ODF render. to add custom filters to the ODF render.
engine = Renderer()
engine = Renderer('template.odt') engine.environment.filters['custom_filter'] = filterFn
engine.environment.filters['custom_filer'] = filter_function result = engine.render('template.odt', var1=val1, ...)
result = engine.render()
""" """
def __init__(self, environment=None, **kwargs): def __init__(self, environment=None, **kwargs):
@ -125,11 +124,9 @@ class Renderer(object):
Create a Renderer instance. Create a Renderer instance.
args: args:
environment: Use this jinja2 enviroment. If not specified, we environment: Use this jinja2 environment. If not specified, we
create a new environment for this class instance. create a new environment for this class instance.
returns:
None
""" """
self.log = logging.getLogger(__name__) self.log = logging.getLogger(__name__)
self.log.debug('Initing a Renderer instance\nTemplate') self.log.debug('Initing a Renderer instance\nTemplate')