Clean up exception API docs.

Part of #28.
lemon24 · May 6, 2018 · d234688 · d234688
1 parent 50745cd
commit d234688
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 16 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -36,36 +36,44 @@ Entry Objects
 Exceptions
 ----------
 
+All exceptions that :class:`Reader` explicitly raises inherit from :exc:`ReaderError`.
+
+
 .. autoclass:: ReaderError
     :members:
-    :inherited-members:
 
-.. autoclass:: FeedError
+.. autoexception:: FeedError
     :members:
-    :inherited-members:
 
-.. autoclass:: FeedExistsError
+    Subclass of :exc:`ReaderError`.
+
+.. autoexception:: FeedExistsError
     :members:
-    :inherited-members:
 
-.. autoclass:: FeedNotFoundError
+    Subclass of :exc:`FeedError`.
+
+.. autoexception:: FeedNotFoundError
     :members:
-    :inherited-members:
 
-.. autoclass:: ParseError
+    Subclass of :exc:`FeedError`.
+
+.. autoexception:: ParseError
     :members:
-    :inherited-members:
 
-.. autoclass:: EntryError
+    Subclass of :exc:`FeedError`.
+
+.. autoexception:: EntryError
     :members:
-    :inherited-members:
 
-.. autoclass:: EntryNotFoundError
+    Subclass of :exc:`FeedError`.
+
+.. autoexception:: EntryNotFoundError
     :members:
-    :inherited-members:
 
-.. autoclass:: StorageError
+    Subclass of :exc:`EntryError`.
+
+.. autoexception:: StorageError
     :members:
-    :inherited-members:
 
+    Subclass of :exc:`ReaderError`.
 
diff --git a/reader/exceptions.py b/reader/exceptions.py
@@ -8,11 +8,13 @@ class FeedError(ReaderError):
 
     def __init__(self, url):
         super().__init__(url)
+
+        #: The feed URL.
         self.url = url
 
 
 class FeedExistsError(FeedError):
-    """File already exists."""
+    """Feed already exists."""
 
 
 class FeedNotFoundError(FeedError):
@@ -32,7 +34,11 @@ class EntryError(ReaderError):
 
     def __init__(self, url, id):
         super().__init__(url, id)
+
+        #: The feed URL.
         self.url = url
+
+        #: The entry id.
         self.id = id
 
 class EntryNotFoundError(EntryError):