Skip to content

Commit

Permalink
better docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ralsina committed May 10, 2015
1 parent 7cc53c2 commit c809cde
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 6 deletions.
6 changes: 1 addition & 5 deletions nikola/plugin_categories.py
Expand Up @@ -86,11 +86,7 @@ class PostScanner(BasePlugin):
"""The scan method of these plugins is called by Nikola.scan_posts."""

def scan(self):
"""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.
"""
"""Creates a list of posts from some source. Returns a list of Post objects."""
raise NotImplementedError()


Expand Down
2 changes: 1 addition & 1 deletion nikola/plugins/task/scan_posts.py
Expand Up @@ -40,7 +40,7 @@ class ScanPosts(PostScanner):
name = "scan_posts"

def scan(self):
"""Build final pages from metadata and HTML fragments."""
"""Create list of posts from POSTS and PAGES options."""

seen = set([])
if not self.site.quiet:
Expand Down

0 comments on commit c809cde

Please sign in to comment.