From 45a899225442b97d49f940d92e25abb0a98905ba Mon Sep 17 00:00:00 2001 From: Dag Wieers Date: Wed, 19 Sep 2018 16:02:27 +0200 Subject: [PATCH] Docs: Avoid use of 'default: null' (#45795) Various modules document the default 'null' value, but it causes None to be shown in the documentation explicitly. --- .../ansible_tower/tower_credential.py | 6 +---- .../ansible_tower/tower_inventory_source.py | 24 +++---------------- .../ansible_tower/tower_workflow_template.py | 19 ++++----------- 3 files changed, 8 insertions(+), 41 deletions(-) diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py index 80fb76e227..59933ee2f0 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_credential.py @@ -1,7 +1,7 @@ #!/usr/bin/python # coding: utf-8 -*- -# (c) 2017, Wayne Witzel III +# Copyright: (c) 2017, Wayne Witzel III # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function @@ -74,13 +74,9 @@ options: client: description: - Client or application ID for azure_rm type. - required: False - default: null security_token: description: - STS token for aws type. - required: False - default: null version_added: "2.6" secret: description: diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_inventory_source.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_inventory_source.py index b8f8098fcb..11c6439a1d 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_inventory_source.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_inventory_source.py @@ -1,9 +1,8 @@ #!/usr/bin/python # coding: utf-8 -*- -# -# (c) 2018, Adrien Fleury -# GNU General Public License v3.0+ -# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +# Copyright: (c) 2018, Adrien Fleury +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function __metaclass__ = type @@ -31,8 +30,6 @@ options: description: description: - The description to use for the inventory source. - required: False - default: null inventory: description: - The inventory the source is linked to. @@ -58,7 +55,6 @@ options: credential: description: - Credential to use to retrieve the inventory from. - required: False source_vars: description: - >- @@ -66,24 +62,20 @@ options: file. For example with Openstack, specifying *private: false* would change the output of the openstack.py script. It has to be YAML or JSON. - required: False timeout: description: - Number in seconds after which the Tower API methods will time out. source_project: description: - Use a *project* as a source for the *inventory*. - required: False source_path: description: - Path to the file to use as a source in the selected *project*. - required: False update_on_project_update: description: - >- That parameter will sync the inventory when the project is synced. It can only be used with a SCM source. - required: False type: bool source_regions: description: @@ -91,27 +83,23 @@ options: List of regions for your cloud provider. You can include multiple all regions. Only Hosts associated with the selected regions will be updated. Refer to Ansible Tower documentation for more detail. - required: False instance_filters: description: - >- Provide a comma-separated list of filter expressions. Hosts are imported when all of the filters match. Refer to Ansible Tower documentation for more detail. - required: False group_by: description: - >- Specify which groups to create automatically. Group names will be created similar to the options selected. If blank, all groups above are created. Refer to Ansible Tower documentation for more detail. - required: False source_script: description: - >- The source custom script to use to build the inventory. It needs to exist. - required: False overwrite: description: - >- @@ -123,7 +111,6 @@ options: left in the "all" default group for the inventory. When not checked, local child hosts and groups not found on the external source will remain untouched by the inventory update process. - required: False type: bool overwrite_vars: description: @@ -132,14 +119,12 @@ options: and replaced by those found on the external source. When not checked, a merge will be performed, combining local variables with those found on the external source. - required: False type: bool update_on_launch: description: - >- Each time a job runs using this inventory, refresh the inventory from the selected source before executing job tasks. - required: False type: bool update_cache_timeout: description: @@ -148,17 +133,14 @@ options: job runs and callbacks the task system will evaluate the timestamp of the latest sync. If it is older than Cache Timeout, it is not considered current, and a new inventory sync will be performed. - required: False state: description: - Desired state of the resource. - required: False default: "present" choices: ["present", "absent"] tower_verify_ssl: description: - Tower option to avoid certificates check. - required: False type: bool extends_documentation_fragment: tower ''' diff --git a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_workflow_template.py b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_workflow_template.py index 3454f432d9..4e70ca1a16 100644 --- a/lib/ansible/modules/web_infrastructure/ansible_tower/tower_workflow_template.py +++ b/lib/ansible/modules/web_infrastructure/ansible_tower/tower_workflow_template.py @@ -1,9 +1,8 @@ #!/usr/bin/python # coding: utf-8 -*- -# -# (c) 2018, Adrien Fleury -# GNU General Public License v3.0+ -# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +# Copyright: (c) 2018, Adrien Fleury +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function __metaclass__ = type @@ -27,18 +26,13 @@ options: allow_simultaneous: description: - If enabled, simultaneous runs of this job template will be allowed. - required: False type: bool description: description: - The description to use for the workflow. - required: False - default: null extra_vars: description: - - > - Extra variables used by Ansible in YAML or key=value format. - required: False + - Extra variables used by Ansible in YAML or key=value format. name: description: - The name to use for the workflow. @@ -46,28 +40,23 @@ options: organization: description: - The organization the workflow is linked to. - required: False schema: description: - > The schema is a JSON- or YAML-formatted string defining the hierarchy structure that connects the nodes. Refer to Tower documentation for more information. - required: False survey_enabled: description: - Setting that variable will prompt the user for job type on the workflow launch. - required: False type: bool survey: description: - The definition of the survey associated to the workflow. - required: False state: description: - Desired state of the resource. - required: False default: "present" choices: ["present", "absent"] extends_documentation_fragment: tower