From b33ae1494936cd04fa89bce51e6068829fc89a91 Mon Sep 17 00:00:00 2001 From: Michael Prokop Date: Thu, 26 Sep 2019 16:18:29 +0200 Subject: [PATCH] doc: fix typos (#62852) --- docs/docsite/rst/dev_guide/developing_modules_general_aci.rst | 2 +- docs/docsite/rst/dev_guide/developing_plugins.rst | 2 +- .../docsite/rst/dev_guide/developing_program_flow_modules.rst | 2 +- docs/docsite/rst/dev_guide/platforms/ovirt_dev_guide.rst | 2 +- docs/docsite/rst/network/user_guide/platform_cnos.rst | 2 +- docs/docsite/rst/network/user_guide/platform_enos.rst | 2 +- docs/docsite/rst/network/user_guide/platform_index.rst | 2 +- docs/docsite/rst/network/user_guide/platform_nxos.rst | 2 +- docs/docsite/rst/porting_guides/porting_guide_2.5.rst | 2 +- docs/docsite/rst/reference_appendices/faq.rst | 2 +- docs/docsite/rst/scenario_guides/guide_aci.rst | 2 +- docs/docsite/rst/scenario_guides/guide_vagrant.rst | 2 +- .../scenario_guides/vmware_scenarios/scenario_remove_vm.rst | 2 +- docs/docsite/rst/user_guide/playbooks_best_practices.rst | 2 +- docs/docsite/rst/user_guide/playbooks_filters.rst | 4 ++-- docs/docsite/rst/user_guide/windows_dsc.rst | 2 +- 16 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/docsite/rst/dev_guide/developing_modules_general_aci.rst b/docs/docsite/rst/dev_guide/developing_modules_general_aci.rst index 9a5b6935e42..c013197d6b1 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_general_aci.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_general_aci.rst @@ -325,7 +325,7 @@ You can test your ``construct_url()`` and ``payload()`` arguments without access import json from ansible.module_utils.network.aci.aci import ACIModule - # Just another class mimicking a bare AnsibleModule class for construct_url() and payload() methods + # Just another class mimicing a bare AnsibleModule class for construct_url() and payload() methods class AltModule(): params = dict( host='dummy', diff --git a/docs/docsite/rst/dev_guide/developing_plugins.rst b/docs/docsite/rst/dev_guide/developing_plugins.rst index 2bbfe0d2a3f..caffdf50f71 100644 --- a/docs/docsite/rst/dev_guide/developing_plugins.rst +++ b/docs/docsite/rst/dev_guide/developing_plugins.rst @@ -320,7 +320,7 @@ Lookup plugins pull in data from external data stores. Lookup plugins can be use Lookup plugins are very flexible, allowing you to retrieve and return any type of data. When writing lookup plugins, always return data of a consistent type that can be easily consumed in a playbook. Avoid parameters that change the returned data type. If there is a need to return a single value sometimes and a complex dictionary other times, write two different lookup plugins. -Ansible includes many :ref:`filters ` which can be used to manipulate the data returned by a lookup plugin. Sometimes it makes sense to do the filtering inside the lookup plugin, other times it is better to return results that can be filtered in the playbook. Keep in mind how the data will be referenced when determing the appropriate level of filtering to be done inside the lookup plugin. +Ansible includes many :ref:`filters ` which can be used to manipulate the data returned by a lookup plugin. Sometimes it makes sense to do the filtering inside the lookup plugin, other times it is better to return results that can be filtered in the playbook. Keep in mind how the data will be referenced when determining the appropriate level of filtering to be done inside the lookup plugin. Here's a simple lookup plugin implementation --- this lookup returns the contents of a text file as a variable: diff --git a/docs/docsite/rst/dev_guide/developing_program_flow_modules.rst b/docs/docsite/rst/dev_guide/developing_program_flow_modules.rst index 6618bb4ceda..25600076485 100644 --- a/docs/docsite/rst/dev_guide/developing_program_flow_modules.rst +++ b/docs/docsite/rst/dev_guide/developing_program_flow_modules.rst @@ -620,7 +620,7 @@ no_log aliases """"""" -``aliases`` accepts a list of alternative argument names for the argument, such as the case where the argument is ``name`` but the module accepts ``aliases=['pkg']`` to allow ``pkg`` to be interchangably with ``name`` +``aliases`` accepts a list of alternative argument names for the argument, such as the case where the argument is ``name`` but the module accepts ``aliases=['pkg']`` to allow ``pkg`` to be interchangeably with ``name`` options """"""" diff --git a/docs/docsite/rst/dev_guide/platforms/ovirt_dev_guide.rst b/docs/docsite/rst/dev_guide/platforms/ovirt_dev_guide.rst index 56df1671436..d61042f6229 100644 --- a/docs/docsite/rst/dev_guide/platforms/ovirt_dev_guide.rst +++ b/docs/docsite/rst/dev_guide/platforms/ovirt_dev_guide.rst @@ -44,7 +44,7 @@ Libraries along with ``ovirt_full_argument_spec``. - All info modules should use ``extends_documentation_fragment``: ``ovirt_info`` to go along with ``ovirt_info_full_argument_spec``. -- Functions that are common to all modules should be implemeneted in the +- Functions that are common to all modules should be implemented in the ``module_utils/ovirt.py`` file, so they can be reused. - Python SDK version 4 must be used. diff --git a/docs/docsite/rst/network/user_guide/platform_cnos.rst b/docs/docsite/rst/network/user_guide/platform_cnos.rst index 664d7924718..70201d7f382 100644 --- a/docs/docsite/rst/network/user_guide/platform_cnos.rst +++ b/docs/docsite/rst/network/user_guide/platform_cnos.rst @@ -65,7 +65,7 @@ Example CLI Task .. code-block:: yaml - - name: Retreive CNOS OS version + - name: Retrieve CNOS OS version cnos_command: commands: show version when: ansible_network_os == 'cnos' diff --git a/docs/docsite/rst/network/user_guide/platform_enos.rst b/docs/docsite/rst/network/user_guide/platform_enos.rst index 142ccf771c3..02f7386a7e2 100644 --- a/docs/docsite/rst/network/user_guide/platform_enos.rst +++ b/docs/docsite/rst/network/user_guide/platform_enos.rst @@ -67,7 +67,7 @@ Example CLI Task .. code-block:: yaml - - name: Retreive ENOS OS version + - name: Retrieve ENOS OS version enos_command: commands: show version when: ansible_network_os == 'enos' diff --git a/docs/docsite/rst/network/user_guide/platform_index.rst b/docs/docsite/rst/network/user_guide/platform_index.rst index 6083c25d2d3..cbbad65e28a 100644 --- a/docs/docsite/rst/network/user_guide/platform_index.rst +++ b/docs/docsite/rst/network/user_guide/platform_index.rst @@ -41,7 +41,7 @@ Settings by Platform .. raw:: html