improve docs, add badge

orcasgit · Oct 6, 2015 · 8f4ae5b · 8f4ae5b
1 parent 5f7aa14
commit 8f4ae5b
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -10,6 +10,9 @@ python-misfit
 .. image:: https://requires.io/github/orcasgit/python-misfit/requirements.svg?branch=master
    :target: https://requires.io/github/orcasgit/python-misfit/requirements/?branch=master
    :alt: Requirements Status
+.. image:: https://readthedocs.org/projects/python-misfit/badge/?version=latest
+   :target: http://python-misfit.readthedocs.org/en/latest/?badge=latest
+   :alt: Documentation Status
 
 Misfit API Python Client Implementation
 

diff --git a/docs/misfit.rst b/docs/misfit.rst
@@ -26,6 +26,11 @@ misfit.cli module
    :end-before: """
 .. autoclass:: misfit.cli.MisfitCli
 
+misfit.notification module
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: misfit.notification
+
 misfit.exceptions module
 ^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/misfit/notification.py b/misfit/notification.py
@@ -22,6 +22,10 @@ def string_to_sign(data):
 
 
 class MisfitMessage(MisfitObject):
+    """
+    DELETED, CREATED and UPDATED are the three known actions you will find in
+    the ``action`` property
+    """
     DELETED = 'deleted'
     CREATED = 'created'
     UPDATED = 'updated'