summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.rst16
-rw-r--r--pystache/parser.py1
2 files changed, 8 insertions, 9 deletions
diff --git a/README.rst b/README.rst
index a922c2d..3347455 100644
--- a/README.rst
+++ b/README.rst
@@ -65,19 +65,18 @@ Use It
You can also create dedicated view classes to hold your view logic.
-Here's your view class (in examples/readme.py)::
+Here's your view class (in .../examples/readme.py)::
class SayHello(object):
-
def to(self):
return "Pizza"
-Like so::
+Instantiating like so::
>>> from pystache.tests.examples.readme import SayHello
>>> hello = SayHello()
-Then your template, say_hello.mustache (in the same directory by default
+Then your template, say_hello.mustache (by default in the same directory
as your class definition)::
Hello, {{to}}!
@@ -89,16 +88,15 @@ Pull it together::
Hello, Pizza!
For greater control over rendering (e.g. to specify a custom template directory),
-use the ``Renderer`` class directly. One can pass attributes to the class's
-constructor or set them on an instance.
+use the ``Renderer`` class like above. One can pass attributes to the
+Renderer class constructor or set them on a Renderer instance.
To customize template loading on a per-view basis, subclass ``TemplateSpec``.
See the docstrings of the Renderer_ class and TemplateSpec_ class for
more information.
-Try parsing a template: ::
+You can also parse a template: ::
- >>> from pystache import parse
- >>> parse("Hey {{#you}}{{.}}!{{/you}}")
+ >>> pystache.parse("Hey {{#you}}{{.}}!{{/you}}")
['Hey ', _SectionNode(key='you', index_begin=12, index_end=18, parsed=[_EscapeNode(key='.'), '!'])]
diff --git a/pystache/parser.py b/pystache/parser.py
index d814b55..0365f76 100644
--- a/pystache/parser.py
+++ b/pystache/parser.py
@@ -17,6 +17,7 @@ NON_BLANK_RE = re.compile(ur'^(.)', re.M)
# TODO: add some unit tests for this.
# TODO: add a test case that checks for spurious spaces.
+# TODO: add test cases for delimiters.
def parse(template, delimiters=None):
"""
Parse a unicode template string and return a ParsedTemplate instance.