From 54a1f1af4b1f601296f760b6b377cd53e3494bdd Mon Sep 17 00:00:00 2001 From: Adrian Damian Date: Mon, 7 May 2018 23:41:16 +0300 Subject: [PATCH] Add Reader docstring. Part of #28. --- reader/reader.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/reader/reader.py b/reader/reader.py index 8a51cde7..c333266a 100644 --- a/reader/reader.py +++ b/reader/reader.py @@ -40,6 +40,16 @@ def wrap_storage_exceptions(*args): class Reader: + """A feed reader. + + Args: + path (str): Path to the reader database. + + Raises: + StorageError + + """ + _get_entries_chunk_size = 2 ** 8 _parse = staticmethod(parse)