Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs linting fixups (ansible-collections#1100)
Browse files Browse the repository at this point in the history
Docs linting fixups

SUMMARY
While testing out linting/validation of the generated docs, a number of issues were highlighted.
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
plugins/modules/aws_batch_job_definition.py
plugins/modules/aws_config_rule.py
plugins/modules/aws_secret.py
plugins/modules/aws_waf_rule.py
plugins/modules/cloudfront_invalidation.py
plugins/modules/ec2_placement_group_info.py
plugins/modules/iam_user.py
plugins/modules/route53_health_check.py
plugins/modules/s3_sync.py
ADDITIONAL INFORMATION

Reviewed-by: Markus Bergholz <git@osuv.de>

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@c5363d5
tremble authored and goneri committed Sep 22, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 8b88921 commit db46ec9
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions plugins/modules/iam_user.py
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@
short_description: Manage AWS IAM users
description:
- A module to manage AWS IAM users.
- The module does not manage groups that users belong to, groups memberships can be managed using `iam_group`.
- The module does not manage groups that users belong to, groups memberships can be managed using M(community.aws.iam_group).
author: Josh Souza (@joshsouza)
options:
name:
@@ -104,7 +104,7 @@
EXAMPLES = r'''
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Note: This module does not allow management of groups that users belong to.
# Groups should manage their membership directly using `iam_group`,
# Groups should manage their membership directly using community.aws.iam_group,
# as users belong to them.
- name: Create a user

0 comments on commit db46ec9

Please sign in to comment.