Documentation changes

ashah-splunk · ashah-splunk · commit f49d37c2909b · 2022-04-19T16:33:22.000+05:30
updated the comments and changes for JSONResultsReader class to be added in the generated docs
diff --git a/docs/results.rst b/docs/results.rst
@@ -5,4 +5,4 @@ splunklib.results
 
 .. autoclass:: Message
 
-.. autoclass:: ResultsReader
+.. autoclass:: JSONResultsReader
diff --git a/splunklib/binding.py b/splunklib/binding.py
@@ -800,9 +800,6 @@ def request(self, path_segment, method="GET", headers=None, body={},
         :type app: ``string``
         :param sharing: The sharing mode of the namespace (optional).
         :type sharing: ``string``
-        :param query: All other keyword arguments, which are used as query
-            parameters.
-        :type query: ``string``
         :return: The response from the server.
         :rtype: ``dict`` with keys ``body``, ``headers``, ``reason``,
                 and ``status``
diff --git a/splunklib/client.py b/splunklib/client.py
@@ -3029,7 +3029,7 @@ def itemmeta(self):
     def oneshot(self, query, **params):
         """Run a oneshot search and returns a streaming handle to the results.
 
-        The ``InputStream`` object streams XML fragments from the server. To parse this stream into usable Python
+        The ``InputStream`` object streams fragments from the server. To parse this stream into usable Python
         objects, pass the handle to :class:`splunklib.results.JSONResultsReader` along with the query param
         "output_mode='json'" ::
 
diff --git a/splunklib/results.py b/splunklib/results.py
@@ -23,7 +23,7 @@
 accessing search results while avoiding buffering the result set, which can be
 very large.
 
-To use the reader, instantiate :class:`ResultsReader` on a search result stream
+To use the reader, instantiate :class:`JSONResultsReader` on a search result stream
 as follows:::
 
     reader = ResultsReader(result_stream)
@@ -55,7 +55,8 @@
 
 __all__ = [
     "ResultsReader",
-    "Message"
+    "Message",
+    "JSONResultsReader"
 ]
 
 
@@ -308,11 +309,14 @@ class JSONResultsReader(object):
     :class:`Message` object for Splunk messages. This class has one field,
     ``is_preview``, which is ``True`` when the results are a preview from a
     running search, or ``False`` when the results are from a completed search.
+
     This function has no network activity other than what is implicit in the
     stream it operates on.
-    :param `stream`: The stream to read from (any object that supports
-        ``.read()``).
+
+    :param `stream`: The stream to read from (any object that supports``.read()``).
+
     **Example**::
+
         import results
         response = ... # the body of an HTTP response
         reader = results.JSONResultsReader(response)

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ splunklib.results`
`5`	`5`
`6`	`6`	`.. autoclass:: Message`
`7`	`7`
`8`		`-.. autoclass:: ResultsReader`
	`8`	`+.. autoclass:: JSONResultsReader`