docstrings

Bobspadger · Mar 26, 2018 · 0ef8ba1 · 0ef8ba1
1 parent 73b3dd2
commit 0ef8ba1
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/royal_mail_rest_api/royal_mail_rest_api.py b/royal_mail_rest_api/royal_mail_rest_api.py
@@ -32,12 +32,21 @@ class TrackingApi(RoyalMailBaseClass):
     summary_url = 'mailPieces/{}/summary'
 
     def __init__(self, client_id, client_secret):
+        """
+        Instantiate, store client_id and secret, build headers
+        :param client_id:
+        :param client_secret:
+        """
         self.client_id = client_id
         self.client_secret = client_secret
         self._create_headers()
 
 
     def _create_headers(self):
+        """
+        Create the required headers for interacting with the tracking api
+        :return: Nothing
+        """
         self.header = {'X-IBM-Client-Id': self.client_id,
                        'X-IBM-Client-Secret': self.client_secret,
                        'accept': 'application/json'}