From d9e65e5b6a78d88ba4489b92bc732e8870302cf8 Mon Sep 17 00:00:00 2001 From: David Lynch Date: Mon, 4 Apr 2016 09:58:47 -0500 Subject: [PATCH] Add a little documentation on the extract method --- sites/__init__.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/sites/__init__.py b/sites/__init__.py index adbac1c..c5ba72a 100644 --- a/sites/__init__.py +++ b/sites/__init__.py @@ -21,6 +21,16 @@ class Site: raise NotImplementedError() def extract(self, url): + """Download a story from a given URL + + Args: + url (string): A valid URL for this Site + Returns: + story (dict) containing keys: + title (string) + author (string) + chapters (list): list of tuples, in form (title, HTML, datetime) + """ raise NotImplementedError() def login(self, login_details):