Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Module DOCUMENTATION should match argspec #34895

Merged
merged 4 commits into from Jan 16, 2018
Merged

Module DOCUMENTATION should match argspec #34895

merged 4 commits into from Jan 16, 2018

Conversation

gundalow
Copy link
Contributor

SUMMARY

Large update of many modules so that DOCUMENTATION option name and
aliases match those defined in the argspec.

Issues identified by #34809

In addition to many typos and missing aliases, the following notable
changes were made:

  • Createmodule_docs_fragments/url.py for url_argument_spec
    * dellos*_command shouldn't have ever had waitfor (incorrectly copied deprecated aliases)
  • ce_aaa_server_host.py s/raduis_server_type/radius_server_type/g
  • junos_lldp enable should be part of state.
ISSUE TYPE
  • Docs Pull Request

@gundalow
Module DOCUMENTATION should match argspec
f809b44 
Large update of many modules so that DOCUMENTATION option name and
aliases match those defined in the argspec.

Issues identified by ansible#34809

In addition to many typos and missing aliases, the following notable
changes were made:

* Create module_docs_fragments/url.py for `url_argument_spec`
* dellos*_command shouldn't have ever had `waitfor` (was incorrectly copied)
* ce_aaa_server_host.py `s/raduis_server_type/radius_server_type/g`
* Junos_lldp enable should be part of `state`.
@ansibot ansibot added affects_2.5 This issue/PR affects Ansible v2.5 docs_pull_request needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. needs_triage Needs a first human triage before being processed. labels Jan 15, 2018
@gundalow gundalow mentioned this pull request Jan 15, 2018
Merged
@gundalow gundalow removed the needs_triage Needs a first human triage before being processed. label Jan 15, 2018
@gundalow
Copy link
Contributor Author

bot_status

@ansibot
Copy link
Contributor

ansibot commented Jan 15, 2018

Components

Metadata

waiting_on: gundalow
changes_requested_by: null
needs_info: False
needs_revision: True
needs_rebase: False
merge_commits: []
mergeable_state: unstable
shippable_status: pending
maintainer_shipits (module maintainers): False
community_shipits (namespace maintainers): False
ansible_shipits (core team members): False
shipit_actors (maintainer or core team member): None
shipit_actors_other:

click here for bot help

sivel
sivel reviewed Jan 15, 2018
View reviewed changes
lib/ansible/modules/cloud/amazon/lambda_alias.py Outdated
'''
- aws
- ec2
'''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this extra space accidental?

sivel
sivel reviewed Jan 15, 2018
View reviewed changes
lib/ansible/modules/cloud/amazon/lambda_facts.py Outdated
'''
- aws
- ec2
'''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra space

sivel
sivel reviewed Jan 15, 2018
View reviewed changes
lib/ansible/modules/cloud/amazon/lambda_policy.py Outdated
'''
- aws
- ec2
'''
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra space

sivel
sivel reviewed Jan 15, 2018
View reviewed changes
lib/ansible/modules/cloud/digital_ocean/digital_ocean_domain.py Outdated
@@ -35,6 +35,7 @@
id:
description:
- Numeric, the droplet id you want to operate on.
aliases: ['droplet_id']
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

over indented

sivel
sivel reviewed Jan 15, 2018
View reviewed changes
lib/ansible/modules/packaging/os/urpmi.py Outdated
@@ -41,6 +41,7 @@
- Corresponds to the C(--no-recommends) option for I(urpmi).
type: bool
default: 'yes'
aliases@ ['no-recommends']
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/@/:/

@sivel
Copy link
Member

sivel commented Jan 15, 2018

In addition to my comments, from the last build (ignoring version_added comments which are invalid):

lib/ansible/modules/cloud/digital_ocean/digital_ocean_certificate.py:48:1: E302 DOCUMENTATION is not valid YAML
lib/ansible/modules/cloud/digital_ocean/digital_ocean_domain.py:38:6: E302 DOCUMENTATION is not valid YAML
lib/ansible/modules/packaging/os/urpmi.py:45:3: E302 DOCUMENTATION is not valid YAML

mattclay
mattclay approved these changes Jan 15, 2018
View reviewed changes
Copy link
Member

@mattclay mattclay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, aside from what @sivel already noted.

@gundalow
Copy link
Contributor Author

Fixed all the issues
CI issues are version_added which will go away once this is merged

@gundalow gundalow merged commit 195beeb into ansible:devel Jan 16, 2018
@gundalow gundalow deleted the docs-fix-args branch January 16, 2018 12:18
@gundalow gundalow mentioned this pull request Jan 18, 2018
Closed
@ansibot ansibot added docs This issue/PR relates to or includes documentation. and removed docs_pull_request labels Mar 4, 2018
@Akasurde Akasurde mentioned this pull request Mar 21, 2018
Closed
@ansible ansible locked and limited conversation to collaborators Apr 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@sivel sivel sivel left review comments

@mattclay mattclay mattclay approved these changes

Assignees
No one assigned
Labels
affects_2.5 This issue/PR affects Ansible v2.5 docs This issue/PR relates to or includes documentation. needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@gundalow @ansibot @sivel @mattclay