Skip to content

Commit

Permalink
Fix incorrect type references
Browse files Browse the repository at this point in the history
  • Loading branch information
samdoran committed Nov 30, 2021
1 parent 62d0dac commit 75fd137
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 48 deletions.
76 changes: 38 additions & 38 deletions ansible_runner/interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ def run(**kwargs):
:type private_data_dir: str
:type ident: str
:type json_mode: bool
:type playbook: str or filename or list
:type playbook: str or list
:type inventory: str or dict or list
:type role: str
:type roles_path: dict or list
Expand All @@ -230,13 +230,13 @@ def run(**kwargs):
:type quiet: bool
:type verbosity: int
:type streamer: str
:type _input: file
:type _output: file
:type event_handler: function
:type cancel_callback: function
:type finished_callback: function
:type status_handler: function
:type artifacts_handler: function
:type _input: io.FileIO
:type _output: io.FileIO
:type event_handler: Callable
:type cancel_callback: Callable
:type finished_callback: Callable
:type status_handler: Callable
:type artifacts_handler: Callable
:type process_isolation: bool
:type process_isolation_executable: str
:type process_isolation_path: str
Expand Down Expand Up @@ -360,9 +360,9 @@ def run_command(executable_cmd, cmdline_args=None, **kwargs):
:type executable_cmd: str
:type cmdline_args: list
:type input_fd: file descriptor
:type output_fd: file descriptor
:type error_fd: file descriptor
:type input_fd: int
:type output_fd: int
:type error_fd: int
:type runner_mode: str
:type host_cwd: str
:type envvars: dict
Expand All @@ -385,11 +385,11 @@ def run_command(executable_cmd, cmdline_args=None, **kwargs):
:type ssh_key: str
:type quiet: bool
:type json_mode: bool
:type event_handler: function
:type cancel_callback: function
:type finished_callback: function
:type status_handler: function
:type artifacts_handler: function
:type event_handler: Callable
:type cancel_callback: Callable
:type finished_callback: Callable
:type status_handler: Callable
:type artifacts_handler: Callable
:type check_job_event_data: bool
:returns: Returns a tuple of response, error string and return code.
Expand Down Expand Up @@ -523,11 +523,11 @@ def get_plugin_docs(plugin_names, plugin_type=None, response_format=None, snippe
:type ssh_key: str
:type quiet: bool
:type json_mode: bool
:type event_handler: function
:type cancel_callback: function
:type finished_callback: function
:type status_handler: function
:type artifacts_handler: function
:type event_handler: Callable
:type cancel_callback: Callable
:type finished_callback: Callable
:type status_handler: Callable
:type artifacts_handler: Callable
:type check_job_event_data: bool
:returns: Returns a tuple of response and error string. In case if ``runner_mode`` is set to ``pexpect`` the error value is empty as
Expand Down Expand Up @@ -639,11 +639,11 @@ def get_plugin_list(list_files=None, response_format=None, plugin_type=None, pla
:type ssh_key: str
:type quiet: bool
:type json_mode: bool
:type event_handler: function
:type cancel_callback: function
:type finished_callback: function
:type status_handler: function
:type artifacts_handler: function
:type event_handler: Callable
:type cancel_callback: Callable
:type finished_callback: Callable
:type status_handler: Callable
:type artifacts_handler: Callable
:type check_job_event_data: bool
:returns: Returns a tuple of response and error string. In case if ``runner_mode`` is set to ``pexpect`` the error value is empty as
Expand Down Expand Up @@ -738,7 +738,7 @@ def get_inventory(action, inventories, response_format=None, host=None, playbook
:type vault_ids: str
:type vault_password_file: str
:type output_file: str
:type: export: bool
:type export: bool
:type runner_mode: str
:type host_cwd: str
:type envvars: dict
Expand All @@ -761,11 +761,11 @@ def get_inventory(action, inventories, response_format=None, host=None, playbook
:type ssh_key: str
:type quiet: bool
:type json_mode: bool
:type event_handler: function
:type cancel_callback: function
:type finished_callback: function
:type status_handler: function
:type artifacts_handler: function
:type event_handler: Callable
:type cancel_callback: Callable
:type finished_callback: Callable
:type status_handler: Callable
:type artifacts_handler: Callable
:type check_job_event_data: bool
:returns: Returns a tuple of response and error string. In case if ``runner_mode`` is set to ``pexpect`` the error value is
Expand Down Expand Up @@ -868,12 +868,12 @@ def get_ansible_config(action, config_file=None, only_changed=None, **kwargs):
:type timeout: int
:type ssh_key: str
:type quiet: bool
:type: json_mode: bool
:type event_handler: function
:type cancel_callback: function
:type finished_callback: function
:type status_handler: function
:type artifacts_handler: function
:type json_mode: bool
:type event_handler: Callable
:type cancel_callback: Callable
:type finished_callback: Callable
:type status_handler: Callable
:type artifacts_handler: Callable
:type check_job_event_data: bool
:returns: Returns a tuple of response and error string. In case if ``runner_mode`` is set to ``pexpect`` the error value is
Expand Down
10 changes: 0 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,17 +176,7 @@ def _get_version():
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

# Strictness settings
nitpicky = True
nitpick_ignore = [
# FIXME: The following entries are used incorrectly in multiple docstrings:
('py:class', 'export: bool'),
('py:class', 'file'),
('py:class', 'file descriptor'),
('py:class', 'filename'),
('py:class', 'function'),
('py:class', 'json_mode: bool'),

# FIXME: Undocumented classes picked up by autodoc as via inheritance:
('py:class', 'ansible.plugins.callback.CallbackBase'),
('py:class', 'ansible.plugins.callback.default.CallbackModule'),
Expand Down

0 comments on commit 75fd137

Please sign in to comment.