Changeset f24c1e758385d50296d1290f716f409882824269

Timestamp:

02/10/12 20:52:14 (4 months ago)

Author:

Paul Winkler <slinkp@…>

Children:

8dd0fb6a1c035d5d3482b4ea9662f1e8d5724c55

Parents:

8ef6d8b58ae443f7e22d0538602a59ff1ad5f710

git-committer:

Paul Winkler <slinkp@…> (02/10/12 20:52:14)

Message:

docstrings

File:

• ebpub/ebpub/db/templatetags/eb.py (modified) (7 diffs)

ebpub/ebpub/db/templatetags/eb.py

@@ -73 +73 @@
     """
     Get singular or plural name of a schema, depending on 'value'.
-
-    Eg. {% schema_plural_name schema 3 %}  --> Restaurant Inspections
+    Example::
+
+        {% schema_plural_name schema 3 %}  --> Restaurant Inspections
         {% schema_plural_name schema 1 %}  --> Restaurant Inspection
 
@@ -88 +89 @@
     ensure sorts always end up the same.
 
-    Example:
-    {% for item in itemlist|safe_id_sort %} ... {% endfor %}
+    Example::
+
+      {% for item in itemlist|safe_id_sort %} ... {% endfor %}
+
     """
     var_resolve = template.Variable(arg).resolve
@@ -172 +175 @@
     Puts get_metro() into the context as METRO>
 
-    Example: {% get_metro %}
+    Examples::
+
+      {% get_metro %}
     """
     return GetMetroNode()
@@ -193 +198 @@
     """
     Puts a newsitem with the given ID in the context with the given
-    variable name
-
-    {% get_newsitem some_id as my_item %}
-    {% get_newsitem '23' as my_other_item %}
+    variable name. Examples::
+
+      {% get_newsitem some_id as my_item %}
+      {% get_newsitem '23' as my_other_item %}
     """
     bits = token.split_contents()
@@ -224 +229 @@
     context variable.
 
-    Example:
-    {% get_more_recent_newsitem [newsitem] [item_list] as [context_var] %}
+    Examples::
+
+      {% get_more_recent_newsitem [newsitem] [item_list] as [context_var] %}
     """
     bits = token.split_contents()
@@ -260 +266 @@
 def do_get_newsitem_list_by_attribute(parser, token):
     """
-
+    Get a list of NewsItems with a given attribute value.
     Syntax:
     {% get_newsitem_list_by_attribute [schema_id] [newsitem_id_to_ignore] [att_name]=[value_or_var_containing_value] as [context_var] %}
 
-    Example:
+    Example::
     {% get_newsitem_list_by_attribute schema.id newsitem.id business_id=attributes.business_id as other_licenses %}
 
@@ -314 +320 @@
     optionally grouped by schema.
 
-    Examples:
-
-    {% newsitem_list_by_schema newsitem "ungrouped" %}
-    {% newsitem_list_by_schema newsitem_list %}
+    Examples::
+
+      {% newsitem_list_by_schema newsitem "ungrouped" %}
+      {% newsitem_list_by_schema newsitem_list %}
 
     """