From 211c300c104313796b1d298e3d95db2d5adaf848 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 31 Aug 2010 12:53:30 +0000 Subject: docstring --- repoze/bfg/renderers.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/repoze/bfg/renderers.py b/repoze/bfg/renderers.py index 0b6a80bb6..13e578d36 100644 --- a/repoze/bfg/renderers.py +++ b/repoze/bfg/renderers.py @@ -27,10 +27,11 @@ def render(renderer_name, value, request=None, package=None): If the renderer name refers to a file on disk (such as when the renderer is a template), it's usually best to supply the name as a - :term:`resource specification`. + :term:`resource specification` + (e.g. ``packagename:path/to/template.pt``). You may supply a relative resource spec as ``renderer_name``. If - the ``package`` argument is supplied, a relative renderer name + the ``package`` argument is supplied, a relative renderer path will be converted to an absolute resource specification by combining the package supplied as ``package`` with the relative resource specification supplied as ``renderer_name``. If you do -- cgit v1.2.3