From 94522b7c103a7caf8bb722ffe8d51c9cf5a7cf3d Mon Sep 17 00:00:00 2001 From: Jorge Vallecillo Date: Mon, 28 Sep 2020 12:33:24 -0600 Subject: [PATCH] Fix typos (#71970) --- .../rst/community/contributing_maintained_collections.rst | 2 +- docs/docsite/rst/dev_guide/debugging.rst | 2 +- docs/docsite/rst/dev_guide/migrating_roles.rst | 2 +- docs/docsite/rst/user_guide/playbooks_variables.rst | 2 +- docs/docsite/rst/user_guide/vault.rst | 2 +- test/units/module_utils/facts/test_date_time.py | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/docsite/rst/community/contributing_maintained_collections.rst b/docs/docsite/rst/community/contributing_maintained_collections.rst index 27778e2e63c..a9ceca58eb6 100644 --- a/docs/docsite/rst/community/contributing_maintained_collections.rst +++ b/docs/docsite/rst/community/contributing_maintained_collections.rst @@ -238,7 +238,7 @@ The following table shows: \*\* Integration tests are required and unit tests are welcomed but not required for the AWS collections. An exception to this is made in cases where integration tests are logistically not feasible due to external requirements. An example of this is AWS Direct Connect, as this service can not be functionally tested without the establishment of network peering connections. Unit tests are therefore required for modules that interact with AWS Direct Connect. Exceptions to ``amazon.aws`` must be approved by Red Hat, and exceptions to ``community.aws`` must be approved by the AWS community. - \*\*\* ``ansible.netcommon`` contains all foundational components for enabling many network and security :ref:`platform ` collections. It contains all connection and filter plugins required, and installs as a dependency when you install the the platform collection. + \*\*\* ``ansible.netcommon`` contains all foundational components for enabling many network and security :ref:`platform ` collections. It contains all connection and filter plugins required, and installs as a dependency when you install the platform collection. \*\*\*\* Unit tests for Windows PowerShell modules are an exception to testing, but unit tests are valid and required for the remainder of the collection, including Ansible-side plugins. diff --git a/docs/docsite/rst/dev_guide/debugging.rst b/docs/docsite/rst/dev_guide/debugging.rst index 6885b2522d3..45ff665616d 100644 --- a/docs/docsite/rst/dev_guide/debugging.rst +++ b/docs/docsite/rst/dev_guide/debugging.rst @@ -77,7 +77,7 @@ The following steps use ``localhost`` as the target host, but you can use the sa │   └── ping.py └── args - * ``AnsiballZ_ping.py`` is the Python script with the the module code stored in a base64 encoded string. It contains various helper functions for executing the module. + * ``AnsiballZ_ping.py`` is the Python script with the module code stored in a base64 encoded string. It contains various helper functions for executing the module. * ``ping.py`` is the code for the module itself. You can modify this code to see what effect it would have on your module, or for debugging purposes. diff --git a/docs/docsite/rst/dev_guide/migrating_roles.rst b/docs/docsite/rst/dev_guide/migrating_roles.rst index a32fa242501..22ac106c33e 100644 --- a/docs/docsite/rst/dev_guide/migrating_roles.rst +++ b/docs/docsite/rst/dev_guide/migrating_roles.rst @@ -207,7 +207,7 @@ If you have a custom ``module_utils`` or import from ``__init__.py``, you must a Updating ``module_utils`` ^^^^^^^^^^^^^^^^^^^^^^^^^ -If any of your custom modules use a custom module utility, once you migrate to a collection you cannot address the module utility in the top level ``ansible.module_utils`` Python namespace. Ansible does not merge content from collections into the the Ansible internal Python namespace. Update any Python import statements that refer to custom module utilities when you migrate your custom content to collections. See :ref:`module_utils in collections ` for more details. +If any of your custom modules use a custom module utility, once you migrate to a collection you cannot address the module utility in the top level ``ansible.module_utils`` Python namespace. Ansible does not merge content from collections into the Ansible internal Python namespace. Update any Python import statements that refer to custom module utilities when you migrate your custom content to collections. See :ref:`module_utils in collections ` for more details. When coding with ``module_utils`` in a collection, the Python import statement needs to take into account the :abbr:`FQCN (Fully Qualified Collection Name)` along with the ``ansible_collections`` convention. The resulting Python import looks similar to the following example: diff --git a/docs/docsite/rst/user_guide/playbooks_variables.rst b/docs/docsite/rst/user_guide/playbooks_variables.rst index eb2b58f7b02..73673476e96 100644 --- a/docs/docsite/rst/user_guide/playbooks_variables.rst +++ b/docs/docsite/rst/user_guide/playbooks_variables.rst @@ -330,7 +330,7 @@ Ansible does apply variable precedence, and you might have a use for it. Here is #. include params #. extra vars (for example, ``-e "user=my_user"``)(always win precedence) -In general, Ansible gives precedence to variables that were defined more recently, more actively, and with more explicit scope. Variables in the the defaults folder inside a role are easily overridden. Anything in the vars directory of the role overrides previous versions of that variable in the namespace. Host and/or inventory variables override role defaults, but explicit includes such as the vars directory or an ``include_vars`` task override inventory variables. +In general, Ansible gives precedence to variables that were defined more recently, more actively, and with more explicit scope. Variables in the defaults folder inside a role are easily overridden. Anything in the vars directory of the role overrides previous versions of that variable in the namespace. Host and/or inventory variables override role defaults, but explicit includes such as the vars directory or an ``include_vars`` task override inventory variables. Ansible merges different variables set in inventory so that more specific settings override more generic settings. For example, ``ansible_ssh_user`` specified as a group_var is overridden by ``ansible_user`` specified as a host_var. For details about the precedence of variables set in inventory, see :ref:`how_we_merge`. diff --git a/docs/docsite/rst/user_guide/vault.rst b/docs/docsite/rst/user_guide/vault.rst index d84aefec483..89c5166097b 100644 --- a/docs/docsite/rst/user_guide/vault.rst +++ b/docs/docsite/rst/user_guide/vault.rst @@ -309,7 +309,7 @@ To create a new encrypted data file called 'foo.yml' with the 'test' vault passw ansible-vault create --vault-id test@multi_password_file foo.yml -The tool launches an editor (whatever editor you have defined with $EDITOR, default editor is vi). Add the content. When you close the the editor session, the file is saved as encrypted data. The file header reflects the vault ID used to create it: +The tool launches an editor (whatever editor you have defined with $EDITOR, default editor is vi). Add the content. When you close the editor session, the file is saved as encrypted data. The file header reflects the vault ID used to create it: .. code-block:: text diff --git a/test/units/module_utils/facts/test_date_time.py b/test/units/module_utils/facts/test_date_time.py index 83dc479bdeb..b57f0efaa9f 100644 --- a/test/units/module_utils/facts/test_date_time.py +++ b/test/units/module_utils/facts/test_date_time.py @@ -84,7 +84,7 @@ def test_date_time_epoch(fake_date_facts): @pytest.mark.parametrize('fact_name', ('tz', 'tz_dst')) def test_date_time_tz(fake_date_facts, fact_name): """ - Test the the returned value for timezone consists of only uppercase + Test the returned value for timezone consists of only uppercase letters and is the expected length. """