From b70e2c961d4e290472587b1a6cd6138686ec2f7c Mon Sep 17 00:00:00 2001
From: Severyn Kozak <severyn.kozak@gmail.com>
Date: Thu, 10 Apr 2014 13:14:27 -0400
Subject: [PATCH] Update assets module with template docstring.

Mod:
    bitshift/assets.py
        -convert existing docstrings to the Sphinx auto-doc format.
---
 bitshift/assets.py | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/bitshift/assets.py b/bitshift/assets.py
index 4754036..90564d2 100644
--- a/bitshift/assets.py
+++ b/bitshift/assets.py
@@ -1,6 +1,6 @@
 """
-Module contains helper functions to be used inside the project's Jinja
-templates.
+.. module:: assets
+   :synopsis: Helper functions for use inside the project's Jinja templates.
 """
 
 from flask import Markup
@@ -12,10 +12,12 @@ ASSET_HTML_TEMPLATES = {
 
 def tag(filename):
     """
-    Return HTML tag for asset named filename.
+    Generate an HTML tag for a CSS/JS asset, based on its file extension.
 
-    Return either a <script> or <link> tag to the file named filename,
-    based on its extension.
+    :param filename: The filename of the asset to create a tag for.
+
+    :return: A string containing a `<source>` tag for JS files, and a `<link>`
+        for CSS files.
     """
 
     file_ext = filename.split(".")[-1]