Fixup docstrings

Itay Neeman · Itay Neeman · commit a453d8511d8a · 2015-11-18T18:50:21.000-08:00
diff --git a/splunklib/client.py b/splunklib/client.py
@@ -3532,7 +3532,7 @@ def __init__(self, service):
         Collection.__init__(self, service, 'storage/collections/config', item=KVStoreCollection)
 
     def create(self, name, indexes = {}, fields = {}, **kwargs):
-        """Creates a KV Store Collection
+        """Creates a KV Store Collection.
 
         :param name: name of collection to create
         :type name: ``string``
@@ -3556,14 +3556,14 @@ def create(self, name, indexes = {}, fields = {}, **kwargs):
 class KVStoreCollection(Entity):
     @property
     def data(self):
-        """Returns data object for this Collection
+        """Returns data object for this Collection.
 
         :rtype: :class:`KVStoreData`
         """
         return KVStoreCollectionData(self)
 
     def update_index(self, name, value):
-        """Changes the definition of a KV Store index
+        """Changes the definition of a KV Store index.
 
         :param name: name of index to change
         :type name: ``string``
@@ -3577,7 +3577,7 @@ def update_index(self, name, value):
         return self.post(**kwargs)
 
     def update_field(self, name, value):
-        """Changes the definition of a KV Store field
+        """Changes the definition of a KV Store field.
 
         :param name: name of field to change
         :type name: ``string``
@@ -3614,7 +3614,7 @@ def _delete(self, url, **kwargs):
 
     def query(self, **query):
         """
-        Gets the results of query, with optional parameters sort, limit, skip, and fields
+        Gets the results of query, with optional parameters sort, limit, skip, and fields.
 
         :param query: Optional parameters. Valid options are sort, limit, skip, and fields
         :type query: ``dict``
@@ -3626,7 +3626,7 @@ def query(self, **query):
 
     def query_by_id(self, id):
         """
-        Return object with _id = id
+        Returns object with _id = id.
 
         :param id: Value for ID. If not a string will be coerced to string.
         :type id: ``string``
@@ -3650,7 +3650,7 @@ def insert(self, data):
 
     def delete(self, query=None):
         """
-        Deletes all data in collection if query is absent. Else, delete all data matched by query.
+        Deletes all data in collection if query is absent. Otherwise, deletes all data matched by query.
 
         :param query: Query to select documents to delete
         :type query: ``string``
@@ -3661,7 +3661,7 @@ def delete(self, query=None):
 
     def delete_by_id(self, id):
         """
-        Deletes document that has _id = id
+        Deletes document that has _id = id.
 
         :param id: id of document to delete
         :type id: ``string``
@@ -3672,7 +3672,7 @@ def delete_by_id(self, id):
 
     def update(self, id, data):
         """
-        Replaces document with _id = id with data
+        Replaces document with _id = id with data.
 
         :param id: _id of document to update
         :type id: ``string``
@@ -3686,7 +3686,7 @@ def update(self, id, data):
 
     def batch_find(self, *dbqueries):
         """
-        Returns array of results from queries dbqueries
+        Returns array of results from queries dbqueries.
 
         :param dbqueries: Array of individual queries as dictionaries
         :type dbqueries: ``array`` of ``dict``
@@ -3703,7 +3703,7 @@ def batch_find(self, *dbqueries):
 
     def batch_save(self, *documents):
         """
-        Inserts or updates every document specified in documents
+        Inserts or updates every document specified in documents.
 
         :param documents: Array of documents to save as dictionaries
         :type documents: ``array`` of ``dict``
