Skip to content

Commit 1c78030

Browse files
committed
Fix param indentation
Continuation lines after a :param: must be indented.
1 parent 55aa2dd commit 1c78030

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

splunklib/modularinput/argument.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ def __init__(self, name, description=None, validation=None,
5454
:param name: ``string``, identifier for this argument in Splunk.
5555
:param description: ``string``, human-readable description of the argument.
5656
:param validation: ``string`` specifying how the argument should be validated, if using internal validation.
57-
If using external validation, this will be ignored.
57+
If using external validation, this will be ignored.
5858
:param data_type: ``string``, data type of this field; use the class constants.
59-
"data_type_boolean", "data_type_number", or "data_type_string".
59+
"data_type_boolean", "data_type_number", or "data_type_string".
6060
:param required_on_edit: ``Boolean``, whether this arg is required when editing an existing modular input of this kind.
6161
:param required_on_create: ``Boolean``, whether this arg is required when creating a modular input of this kind.
6262
:param title: ``String``, a human-readable title for the argument.

splunklib/modularinput/script.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,9 @@ def service(self):
118118
available as soon as the :code:`Script.stream_events` method is
119119
called.
120120
121-
:return: :class:splunklib.client.Service. A value of None is returned,
122-
if you call this method before the :code:`Script.stream_events` method
123-
is called.
121+
:return: :class:`splunklib.client.Service`. A value of None is returned,
122+
if you call this method before the :code:`Script.stream_events` method
123+
is called.
124124
125125
"""
126126
if self._service is not None:

splunklib/searchcommands/external_search_command.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,13 +105,13 @@ def _execute(path, argv=None, environ=None):
105105
106106
:param argv: Argument list.
107107
:type argv: list or tuple
108-
The arguments to the child process should start with the name of the command being run, but this is not
109-
enforced. A value of :const:`None` specifies that the base name of path name :param:`path` should be used.
108+
The arguments to the child process should start with the name of the command being run, but this is not
109+
enforced. A value of :const:`None` specifies that the base name of path name :param:`path` should be used.
110110
111111
:param environ: A mapping which is used to define the environment variables for the new process.
112112
:type environ: dict or None.
113-
This mapping is used instead of the current process’s environment. A value of :const:`None` specifies that
114-
the :data:`os.environ` mapping should be used.
113+
This mapping is used instead of the current process’s environment. A value of :const:`None` specifies that
114+
the :data:`os.environ` mapping should be used.
115115
116116
:return: None
117117

splunklib/searchcommands/search_command.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ def search_results_info(self):
256256
invocation.
257257
258258
:return: Search results info:const:`None`, if the search results info file associated with the command
259-
invocation is inaccessible.
259+
invocation is inaccessible.
260260
:rtype: SearchResultsInfo or NoneType
261261
262262
"""
@@ -345,8 +345,8 @@ def service(self):
345345
:code:`requires_srinfo` setting is false by default. Hence, you must set it.
346346
347347
:return: :class:`splunklib.client.Service`, if :code:`enableheader` and :code:`requires_srinfo` are both
348-
:code:`true`. Otherwise, if either :code:`enableheader` or :code:`requires_srinfo` are :code:`false`, a value
349-
of :code:`None` is returned.
348+
:code:`true`. Otherwise, if either :code:`enableheader` or :code:`requires_srinfo` are :code:`false`, a value
349+
of :code:`None` is returned.
350350
351351
"""
352352
if self._service is not None:

splunklib/searchcommands/validators.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ class Code(Validator):
8181
def __init__(self, mode='eval'):
8282
"""
8383
:param mode: Specifies what kind of code must be compiled; it can be :const:`'exec'`, if source consists of a
84-
sequence of statements, :const:`'eval'`, if it consists of a single expression, or :const:`'single'` if it
85-
consists of a single interactive statement. In the latter case, expression statements that evaluate to
86-
something other than :const:`None` will be printed.
84+
sequence of statements, :const:`'eval'`, if it consists of a single expression, or :const:`'single'` if it
85+
consists of a single interactive statement. In the latter case, expression statements that evaluate to
86+
something other than :const:`None` will be printed.
8787
:type mode: unicode or bytes
8888
8989
"""

0 commit comments

Comments
 (0)