Skip to content

Commit 5bb0e52

Browse files
committed
Doc strings update
Today's slew of edits.
1 parent d935d42 commit 5bb0e52

File tree

2 files changed

+624
-364
lines changed

2 files changed

+624
-364
lines changed

splunklib/binding.py

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -454,8 +454,8 @@ def delete(self, path_segment, owner=None, app=None, sharing=None, **query):
454454
455455
This method is named to match the HTTP method. ``delete`` makes at least
456456
one round trip to the server, one additional round trip for each 303
457-
status returned, and at most two additional round trips if autologin is
458-
enabled.
457+
status returned, and at most two additional round trips if
458+
the ``autologin`` field of :func:`connect` is set to ``True``.
459459
460460
If *owner*, *app*, and *sharing* are omitted, this method uses the
461461
default :class:`Context` namespace. All other keyword arguments are
@@ -484,7 +484,7 @@ def delete(self, path_segment, owner=None, app=None, sharing=None, **query):
484484
485485
c = binding.connect(...)
486486
c.delete('saved/searches/boris') == \\
487-
{'body': '<splunklib.binding.ResponseReader at 0x10f870ad0>', ### take out the quotes
487+
{'body': '...a response reader object...',
488488
'headers': [('content-length', '1786'),
489489
('expires', 'Fri, 30 Oct 1998 00:00:00 GMT'),
490490
('server', 'Splunkd'),
@@ -512,8 +512,8 @@ def get(self, path_segment, owner=None, app=None, sharing=None, **query):
512512
513513
This method is named to match the HTTP method. ``get`` makes at least
514514
one round trip to the server, one additional round trip for each 303
515-
status returned, and at most two additional round trips if autologin is
516-
enabled.
515+
status returned, and at most two additional round trips if
516+
the ``autologin`` field of :func:`connect` is set to ``True``.
517517
518518
If *owner*, *app*, and *sharing* are omitted, this method uses the
519519
default :class:`Context` namespace. All other keyword arguments are
@@ -542,7 +542,7 @@ def get(self, path_segment, owner=None, app=None, sharing=None, **query):
542542
543543
c = binding.connect(...)
544544
c.get('apps/local') == \\
545-
{'body': '<splunklib.binding.ResponseReader at 0x10f8709d0>', ### take out the quotes
545+
{'body': '...a response reader object...',
546546
'headers': [('content-length', '26208'),
547547
('expires', 'Fri, 30 Oct 1998 00:00:00 GMT'),
548548
('server', 'Splunkd'),
@@ -570,8 +570,8 @@ def post(self, path_segment, owner=None, app=None, sharing=None, headers=[], **q
570570
571571
This method is named to match the HTTP method. ``post`` makes at least
572572
one round trip to the server, one additional round trip for each 303
573-
status returned, and at most two additional round trips if autologin is
574-
enabled.
573+
status returned, and at most two additional round trips if
574+
the ``autologin`` field of :func:`connect` is set to ``True``.
575575
576576
If *owner*, *app*, and *sharing* are omitted, this method uses the
577577
default :class:`Context` namespace. All other keyword arguments are
@@ -608,7 +608,7 @@ def post(self, path_segment, owner=None, app=None, sharing=None, headers=[], **q
608608
c = binding.connect(...)
609609
c.post('saved/searches', name='boris',
610610
search='search * earliest=-1m | head 1') == \\
611-
{'body': '<splunklib.binding.ResponseReader at 0x10f870d50>', ### take out the quotes
611+
{'body': '...a response reader object...',
612612
'headers': [('content-length', '10455'),
613613
('expires', 'Fri, 30 Oct 1998 00:00:00 GMT'),
614614
('server', 'Splunkd'),
@@ -673,7 +673,7 @@ def request(self, path_segment, method="GET", headers=[], body="",
673673
674674
c = binding.connect(...)
675675
c.request('saved/searches', method='GET') == \\
676-
{'body': '<splunklib.binding.ResponseReader at 0x10b18fa50>', ### take out the quotes
676+
{'body': '...a response reader object...',
677677
'headers': [('content-length', '46722'),
678678
('expires', 'Fri, 30 Oct 1998 00:00:00 GMT'),
679679
('server', 'Splunkd'),
@@ -828,12 +828,12 @@ def connect(**kwargs):
828828
:type port: ``integer``
829829
:param scheme: The scheme for accessing the service (the default is "https").
830830
:type scheme: "https" or "http"
831-
:param sharing: The sharing mode for the namespace (the default is "user").
832-
:type sharing: "global", "system", "app", or "user"
833831
:param owner: The owner context of the namespace (the default is "None").
834832
:type owner: ``string``
835833
:param app: The app context of the namespace (the default is "None").
836834
:type app: ``string``
835+
:param sharing: The sharing mode for the namespace (the default is "user").
836+
:type sharing: "global", "system", "app", or "user"
837837
:param token: The current session token (optional). Session tokens can be
838838
shared across multiple service instances.
839839
:type token: ``string``
@@ -844,7 +844,7 @@ def connect(**kwargs):
844844
:type password: ``string``
845845
:param autologin: When ``True``, automatically tries to log in again if the
846846
session terminates.
847-
:type autologin: ``boolean``
847+
:type autologin: ``Boolean``
848848
:return: An initialized :class:`Context` instance.
849849
850850
**Example**::

0 commit comments

Comments
 (0)