Improved documentation for get_hook_templates, noting the template tag
authorChristopher Allan Webber <cwebber@dustycloud.org>
Wed, 30 Jan 2013 19:25:08 +0000 (13:25 -0600)
committerChristopher Allan Webber <cwebber@dustycloud.org>
Wed, 30 Jan 2013 19:25:20 +0000 (13:25 -0600)
mediagoblin/tools/pluginapi.py

index 1f28690ecdaabb0a385e23cd5f41f5aca1a65491..5794bf635497ced2fcc85bf82857dd97252bca64 100644 (file)
@@ -244,7 +244,16 @@ def get_hook_templates(hook_name):
     """
     Get a list of hook templates for this hook_name.
 
+    Note: for the most part, you access this via a template tag, not
+    this method directly, like so:
+
+      {% template_hook "media_sidebar" %}
+
+    ... which will include all templates for you, partly using this
+    method.
+
     Returns:
       A list of strings representing template paths.
+
     """
     return PluginManager().get_template_hooks(hook_name)