Less confusing docs for compile_string

Signed-off-by: Chris Warrick <kwpolska@gmail.com>
getnikola · Jan 8, 2017 · 21d63e8 · 21d63e8
1 parent ac35e51
commit 21d63e8
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/nikola/plugin_categories.py b/nikola/plugin_categories.py
@@ -306,7 +306,7 @@ def compile(self, source, dest, is_two_file=True, post=None, lang=None):
     def compile_string(self, data, source_path=None, is_two_file=True, post=None, lang=None):
         """Compile the source file into HTML strings (with shortcode support).
 
-        Returns a tuple of at least two elements (html string, shortcode dependencies).
+        Returns a tuple of at least two elements: HTML string [0] and shortcode dependencies [last].
         """
         # This function used to have some different APIs in different places.
         raise NotImplementedError()