ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-09-30 05:23:21 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: fix sphinx warnings in uthelper guide (#10864)
Some checks failed
EOL CI / EOL Sanity (Ⓐ2.16) (push) Has been cancelled
Details
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Has been cancelled
Details
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Has been cancelled
Details
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Has been cancelled
Details
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Has been cancelled
Details
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Has been cancelled
Details
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Has been cancelled
Details
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Has been cancelled
Details
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Has been cancelled
Details
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Has been cancelled
Details
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Has been cancelled
Details
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Has been cancelled
Details
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Has been cancelled
Details
nox / Run extra sanity tests (push) Has been cancelled
Details

Browse source
This commit is contained in:
Alexei Znamensky 2025-09-28 20:30:54 +13:00 • committed by GitHub
commit 4b644ae41b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/docsite/rst/guide_uthelper.rst
View file

@ -276,9 +276,9 @@ RunCommandMock Specification
Creates an ``UTHelper`` instance from a given test specification. Creates an ``UTHelper`` instance from a given test specification.
:param ansible_module: The Ansible module to be tested. :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. :param test_module: The test module.
:type test_module: module :type test_module: :py:class:`types.ModuleType`
:param test_spec: The test specification. :param test_spec: The test specification.
:type test_spec: dict :type test_spec: dict
:param mocks: List of ``TestCaseMocks`` to be used during testing. Currently only ``RunCommandMock`` exists. :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. Creates an ``UTHelper`` instance from a test specification file.
:param ansible_module: The Ansible module to be tested. :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. :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. :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. :param mocks: List of ``TestCaseMocks`` to be used during testing. Currently only ``RunCommandMock`` exists.
:type mocks: list or None :type mocks: list or None
:return: An ``UTHelper`` instance. :return: An ``UTHelper`` instance.
@ -335,7 +335,7 @@ RunCommandMock Specification
Creates an ``UTHelper`` instance from a given Ansible module and test module. Creates an ``UTHelper`` instance from a given Ansible module and test module.
:param ansible_module: The Ansible module to be tested. :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__``. :param test_module_name: The name of the test module. It works if passed ``__name__``.
:type test_module_name: str :type test_module_name: str
:param mocks: List of ``TestCaseMocks`` to be used during testing. Currently only ``RunCommandMock`` exists. :param mocks: List of ``TestCaseMocks`` to be used during testing. Currently only ``RunCommandMock`` exists.