Fix linting issues. (#701) #806
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix linting issues reported by validate-modules in plugins SUMMARY See ansible-collections/news-for-maintainers#9. ISSUE TYPE Bugfix Pull Request COMPONENT NAME various Reviewed-by: Jill R <None>
ansibullbot
added
bug
Yet more sanity cleanup
SUMMARY
ansible/ansible devel has some more docs sanity tests in the works. Get ahead of them
ISSUE TYPE
Docs Pull Request
COMPONENT NAME
plugins/inventory/aws_ec2.py
plugins/inventory/aws_rds.py
plugins/modules/ec2_instance.py
plugins/modules/ec2_snapshot_info.py
ADDITIONAL INFORMATION
ERROR: Found 11 validate-modules issue(s) which need to be resolved:
ERROR: plugins/inventory/aws_ec2.py:0:0: parameter-list-no-elements: DOCUMENTATION.options.exclude_filters: Argument defines type as list but elements is not defined for dictionary value @ data['options']['exclude_filters']. Got {'description': ['A list of filters. Any instances matching one of the filters are excluded from the result.', 'The filters from C(exclude_filters) take priority over the C(include_filters) and C(filters) keys', 'Available filters are listed here U(http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html#options).', "Every entry in this list triggers a search query. As such, from a performance point of view, it's better to keep the list as short as possible."], 'type': 'lis...
ERROR: plugins/inventory/aws_ec2.py:0:0: parameter-list-no-elements: DOCUMENTATION.options.hostnames: Argument defines type as list but elements is not defined for dictionary value @ data['options']['hostnames']. Got {'description': ['A list in order of precedence for hostname variables.', 'You can use the options specified in U(http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html#options).', 'To use tags as hostnames use the syntax tag:Name=Value to use the hostname Name_Value, or tag:Name to use the value of the Name tag.'], 'type': 'list', 'default': []}
ERROR: plugins/inventory/aws_ec2.py:0:0: parameter-list-no-elements: DOCUMENTATION.options.include_filters: Argument defines type as list but elements is not defined for dictionary value @ data['options']['include_filters']. Got {'description': ['A list of filters. Any instances matching at least one of the filters are included in the result.', 'Available filters are listed here U(http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html#options).', "Every entry in this list triggers a search query. As such, from a performance point of view, it's better to keep the list as short as possible."], 'type': 'list', 'default': []}
ERROR: plugins/inventory/aws_ec2.py:0:0: parameter-list-no-elements: DOCUMENTATION.options.regions: Argument defines type as list but elements is not defined for dictionary value @ data['options']['regions']. Got {'description': ['A list of regions in which to describe EC2 instances.', 'If empty (the default) default this will include all regions, except possibly restricted ones like us-gov-west-1 and cn-north-1.'], 'type': 'list', 'default': []}
ERROR: plugins/inventory/aws_rds.py:0:0: parameter-list-no-elements: DOCUMENTATION.options.statuses: Argument defines type as list but elements is not defined for dictionary value @ data['options']['statuses']. Got {'description': "A list of desired states for instances/clusters to be added to inventory. Set to ['all'] as a shorthand to find everything.", 'type': 'list', 'default': ['creating', 'available']}
ERROR: plugins/modules/ec2_instance.py:0:0: parameter-list-no-elements: DOCUMENTATION.options.network.suboptions.groups: Argument defines type as list but elements is not defined for dictionary value @ data['options']['network']['suboptions']['groups']. Got {'description': ['a list of security group IDs to attach to the interface'], 'type': 'list'}
ERROR: plugins/modules/ec2_instance.py:0:0: parameter-list-no-elements: DOCUMENTATION.options.network.suboptions.interfaces: Argument defines type as list but elements is not defined for dictionary value @ data['options']['network']['suboptions']['interfaces']. Got {'description': ['a list of ENI IDs (strings) or a list of objects containing the key I(id).'], 'type': 'list'}
ERROR: plugins/modules/ec2_instance.py:0:0: parameter-list-no-elements: DOCUMENTATION.options.network.suboptions.ipv6_addresses: Argument defines type as list but elements is not defined for dictionary value @ data['options']['network']['suboptions']['ipv6_addresses']. Got {'description': ['a list of IPv6 addresses to assign to the network interface'], 'type': 'list'}
ERROR: plugins/modules/ec2_instance.py:0:0: parameter-list-no-elements: DOCUMENTATION.options.network.suboptions.private_ip_addresses: Argument defines type as list but elements is not defined for dictionary value @ data['options']['network']['suboptions']['private_ip_addresses']. Got {'description': ['a list of IPv4 addresses to assign to the network interface'], 'type': 'list'}
ERROR: plugins/modules/ec2_snapshot_info.py:0:0: documentation-error: Unknown DOCUMENTATION error, see TRACE: while scanning a simple key
in "<unicode string>", line 72, column 13
could not find expected ':'
in "<unicode string>", line 73, column 13
Reviewed-by: Felix Fontein <[email protected]>
goneri
approved these changes
May 10, 2022
|
I think it would be easier to have two backport PRs like it was for the original PRs. |
|
regate |
softwarefactory-project-zuul
bot
merged commit f5ef9dd
into
ansible-collections:stable-3
tremble
pushed a commit
to tremble/amazon.aws
that referenced
this pull request
May 19, 2022
Fix linting issues. (ansible-collections#701) Should fix ansible-collections#804 Fix linting issues reported by validate-modules in plugins SUMMARY See ansible-collections/news-for-maintainers#9. ISSUE TYPE Bugfix Pull Request COMPONENT NAME various Reviewed-by: Jill R SUMMARY ISSUE TYPE Bugfix Pull Request Docs Pull Request Feature Pull Request New Module Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Gonéri Le Bouder <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Should fix #804
Fix linting issues reported by validate-modules in plugins
SUMMARY
See ansible-collections/news-for-maintainers#9.
ISSUE TYPE
Bugfix Pull Request
COMPONENT NAME
various
Reviewed-by: Jill R
SUMMARY
ISSUE TYPE
COMPONENT NAME
ADDITIONAL INFORMATION