From c2adcfa51d592d6fd5fc21ea4ea84f5e58a04e09 Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Sun, 28 Sep 2025 12:42:23 +0200 Subject: [PATCH] [PR #10864/4b644ae4 backport][stable-11] docs: fix sphinx warnings in uthelper guide (#10865) docs: fix sphinx warnings in uthelper guide (#10864) (cherry picked from commit 4b644ae41bc87e523821fed4e7ac7748017c4cfe) Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> --- docs/docsite/rst/guide_uthelper.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/docsite/rst/guide_uthelper.rst b/docs/docsite/rst/guide_uthelper.rst index 657ced66cf..c4a4110d70 100644 --- a/docs/docsite/rst/guide_uthelper.rst +++ b/docs/docsite/rst/guide_uthelper.rst @@ -276,9 +276,9 @@ RunCommandMock Specification Creates an ``UTHelper`` instance from a given test specification. :param ansible_module: The Ansible module to be tested. - :type ansible_module: module + :type ansible_module: :py:class:`types.ModuleType` :param test_module: The test module. - :type test_module: module + :type test_module: :py:class:`types.ModuleType` :param test_spec: The test specification. :type test_spec: dict :param mocks: List of ``TestCaseMocks`` to be used during testing. Currently only ``RunCommandMock`` exists. @@ -308,11 +308,11 @@ RunCommandMock Specification Creates an ``UTHelper`` instance from a test specification file. :param ansible_module: The Ansible module to be tested. - :type ansible_module: module + :type ansible_module: :py:class:`types.ModuleType` :param test_module: The test module. - :type test_module: module + :type test_module: :py:class:`types.ModuleType` :param test_spec_filehandle: A file handle to an file stream handle providing the test specification in YAML format. - :type test_spec_filehandle: file + :type test_spec_filehandle: ``file-like object`` :param mocks: List of ``TestCaseMocks`` to be used during testing. Currently only ``RunCommandMock`` exists. :type mocks: list or None :return: An ``UTHelper`` instance. @@ -335,7 +335,7 @@ RunCommandMock Specification Creates an ``UTHelper`` instance from a given Ansible module and test module. :param ansible_module: The Ansible module to be tested. - :type ansible_module: module + :type ansible_module: :py:class:`types.ModuleType` :param test_module_name: The name of the test module. It works if passed ``__name__``. :type test_module_name: str :param mocks: List of ``TestCaseMocks`` to be used during testing. Currently only ``RunCommandMock`` exists.