docs (#13)

Bobspadger · Mar 29, 2018 · 3951efc · 3951efc
1 parent 01ab24f
commit 3951efc
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -8,6 +8,7 @@ To use Royal Mail Rest API in a project:
     (this is from the example.py file which will be updated, its worth looking there)
 
 .. code-block:: python
+
     import json
     from royal_mail_rest_api.tools import RoyalMailBody
     from royal_mail_rest_api.shipping import ShippingApi

diff --git a/royal_mail_rest_api/shipping.py b/royal_mail_rest_api/shipping.py
@@ -3,6 +3,9 @@
 
 
 class ShippingApi(RoyalMailBaseClass):
+    """
+    Royal Mail Shipping Class, used to communicate with the Royal Mail Rest API to create labels
+    """
     token_url = '/shipping/v2/token'
     post_domestic_url = '/shipping/v2/domestic'
     delete_shipment_url = '/shipping/v2/'
@@ -167,6 +170,3 @@ def put_manifest(self, sales_order_number=None, manifest_batch_number=None):
                               headers=self.tokenheader)
         result.raise_for_status()
         return result.json()
-
-
-