Added documentation and a deprecation warning in code. fix #2086.

getnikola · Sep 22, 2015 · 1725a5a · 1725a5a
1 parent 4b3d125
commit 1725a5a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -20,6 +20,12 @@ Bugfixes
 * /robots.txt was never being built (Issue #2098)
 * SVG thumbnails (Issue #2094)
 
+Deprecations
+------------
+
+* Post.section_link is now deprecated (Issue #2086). Use
+  site.link('index_section_path', post.section_slug()) instead.
+
 New in v7.7.1
 =============
 

diff --git a/nikola/post.py b/nikola/post.py
@@ -745,6 +745,8 @@ def section_color(self, lang=None):
 
     def section_link(self, lang=None):
         """Return the link to the post's section (deprecated)."""
+        utils.LOGGER.warning("Post.section_link is deprecated. Please use " +
+                             "site.link('index_section_path', post.section_slug()) instead.")
         if lang is None:
             lang = nikola.utils.LocaleBorg().current_lang