From bb2925d9f775966b666babc1ca7ed5ed9e87be65 Mon Sep 17 00:00:00 2001
From: Ian Murray <ian.c.murray@gmail.com>
Date: Thu, 13 Sep 2012 13:42:39 +0100
Subject: [PATCH] [#2375] Include docstring for deprecated helper function

---
 ckan/lib/helpers.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/ckan/lib/helpers.py b/ckan/lib/helpers.py
index 6a07bf947c4..55b49404d58 100644
--- a/ckan/lib/helpers.py
+++ b/ckan/lib/helpers.py
@@ -522,6 +522,13 @@ def unselected_facet_items(facet, limit=10):
     return get_facet_items_dict(facet, limit=limit, exclude_active=True)
 
 def facet_title(name):
+    '''Returns a title for the given facet name.
+    
+    If a mapping is declared in the config, this is used.  Otherwise it falls
+    back to capitalizing the given name.
+
+    This function is deprecated, use `get_facet_title` instead.
+    '''
     # FIXME this looks like an i18n issue
     return config.get('search.facets.%s.title' % name, name.capitalize())