Update docstrings

Author: cmlccie

ciscosparkapi/api/memberships.py

@@ -175,6 +175,9 @@ def create(self, roomId, personId=None, personEmail=None,
             isModerator(bool): If True, adds the person as a moderator for the
                 room. If False, adds the person as normal member of the room.
 
+        Returns:
+            Membership: With the details of the created membership.
+
         Raises:
             AssertionError: If the parameter types are incorrect.
             ciscosparkapiException: If neither a personId or personEmail are
@@ -209,6 +212,9 @@ def get(self, membershipId):
         Args:
             membershipId(unicode, str): The membershipId of the membership.
 
+        Returns:
+            Membership: With the details of the requested membership.
+
         Raises:
             AssertionError: If the parameter types are incorrect.
             SparkApiError: If the Cisco Spark cloud returns an error.
@@ -233,7 +239,7 @@ def update(self, membershipId, **update_attributes):
                 room. If False, removes the person as a moderator for the room.
 
         Returns:
-            A Person object with the updated Spark membership details.
+            Membership: With the updated Spark membership details.
 
         Raises:
             AssertionError: If the parameter types are incorrect.

ciscosparkapi/api/people.py

@@ -145,6 +145,9 @@ def get(self, personId):
         Args:
             personId(unicode, str): The personID of the person.
 
+        Returns:
+            Person: With the details of the requested person.
+
         Raises:
             AssertionError: If the parameter types are incorrect.
             SparkApiError: If the Cisco Spark cloud returns an error.

ciscosparkapi/api/rooms.py

@@ -18,7 +18,7 @@ class Room(SparkData):
     """Model a Spark 'room' JSON object as a native Python object."""
 
     def __init__(self, json):
-        """Init a new Person data object from a JSON dictionary or string.
+        """Init a new Room data object from a JSON dictionary or string.
 
         Args:
             json(dict, unicode, str): Input JSON object.
@@ -123,7 +123,7 @@ def list(self, max=None, **query_params):
                     'group': returns all group rooms.
 
         Yields:
-            Person: The the next room from the Cisco Spark query.
+            Room: The the next room from the Cisco Spark query.
 
         Raises:
             AssertionError: If the parameter types are incorrect.
@@ -143,7 +143,7 @@ def list(self, max=None, **query_params):
                 params[utf8(param)] = value
         # API request - get items
         items = self.session.get_items('rooms', params=params)
-        # Yield Person objects created from the returned items JSON objects
+        # Yield Room objects created from the returned items JSON objects
         for item in items:
             yield Room(item)
 
@@ -157,6 +157,9 @@ def create(self, title, teamId=None):
             teamId(unicode, str): The team ID with which this room is
                 associated.
 
+        Returns:
+            Room: With the details of the created room.
+
         Raises:
             AssertionError: If the parameter types are incorrect.
             SparkApiError: If the Cisco Spark cloud returns an error.
@@ -180,6 +183,9 @@ def get(self, roomId):
         Args:
             roomId(unicode, str): The roomId of the room.
 
+        Returns:
+            Room: With the details of the requested room.
+
         Raises:
             AssertionError: If the parameter types are incorrect.
             SparkApiError: If the Cisco Spark cloud returns an error.
@@ -202,7 +208,7 @@ def update(self, roomId, **update_attributes):
             title(unicode, str): A user-friendly name for the room.
 
         Returns:
-            A Person object with the updated Spark room details.
+            Room: With the updated Spark room details.
 
         Raises:
             AssertionError: If the parameter types are incorrect.