Skip to content

Commit fb9fcc8

Browse files
author
David Noble
committed
Documentation update
1 parent d4b2dea commit fb9fcc8

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

splunklib/searchcommands/__init__.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -237,11 +237,11 @@ def dispatch(command_class, argv=sys.argv, input_file=sys.stdin, output_file=
237237
if module_name is None or module_name == '__main__':
238238
# execute command
239239
240-
If you would like the module calling this function to act as either a
241-
reusable module or a standalone program, call it at module scope passing
242-
`__name__` as the value of `module_name`. Otherwise, if you wish this
243-
function to unconditionally instantiate and execute `command_class`, pass
244-
`None` as the value of `module_name`.
240+
If you would like this function's caller to act as either a reusable module
241+
or a standalone program, call it at module scope with `__name__` as the
242+
value of `module_name`. Otherwise, if you wish this function to
243+
unconditionally instantiate and execute `command_class`, pass `None` as the
244+
value of `module_name`.
245245
246246
:param command_class: Class to instantiate and execute.
247247
:type command_class: ``.search_command.SearchCommand``
@@ -253,6 +253,7 @@ def dispatch(command_class, argv=sys.argv, input_file=sys.stdin, output_file=
253253
:type output_file: ``file``
254254
:param module_name: Name of the module calling dispatch or `None`.
255255
:type module_name: ``str``
256+
:returns: ``None``
256257
257258
**Example**::
258259

0 commit comments

Comments
 (0)