updated plugin doc

getnikola · May 9, 2015 · 2fe0484 · 2fe0484
1 parent bc0e815
commit 2fe0484
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/nikola/plugin_categories.py b/nikola/plugin_categories.py
@@ -86,7 +86,11 @@ class PostScanner(BasePlugin):
     """The scan method of these plugins is called by Nikola.scan_posts."""
 
     def scan(self):
-        """Load posts into the timeline."""
+        """Creates a list of posts from some source. Returns timeline, global_data:
+
+        timeline is a list of Post objects
+        global_data is a dictionary where keys are source paths and values are posts. 
+        """
         raise NotImplementedError()