Skip to content
Browse files
updated plugin doc
  • Loading branch information
ralsina committed May 9, 2015
1 parent bc0e815 commit 2fe0484cdb3885e4cbd4cc75f64af6ee53a5c595
Showing 1 changed file with 5 additions and 1 deletion.
@@ -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()

0 comments on commit 2fe0484

Please sign in to comment.