-
Notifications
You must be signed in to change notification settings - Fork 341
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.
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
Update return block of ec2 modules (part 2) #2079
Update return block of ec2 modules (part 2) #2079
Conversation
Docs Build 📝Thank you for contribution!✨ This PR has been merged and your docs changes will be incorporated when they are next published. |
Build failed. ❌ ansible-galaxy-importer FAILURE in 5m 23s |
6604d79
to
a750958
Compare
Build failed. ❌ ansible-galaxy-importer FAILURE in 4m 31s |
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 4m 47s |
plugins/modules/ec2_vpc_subnet.py
Outdated
@@ -138,6 +138,11 @@ | |||
returned: I(state=present) | |||
type: str | |||
sample: us-east-1a | |||
availability_zone_id: | |||
description: The AZ ID of the subnet. | |||
returned: I(state=present) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
returned: I(state=present) | |
returned: O(state=present) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please share the reason behind this suggestion?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
describes here in the section Semantic markup within module documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed! I am curious if there is a guideline that prioritizes semantic markup over macros. However, I think it would be advantageous to incorporate this as a guideline in the cloud content coding standards document.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Just some minor remark to address
Build failed. ✔️ ansible-galaxy-importer SUCCESS in 5m 59s |
ba0e461
to
832b180
Compare
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 4m 42s |
eb42985
to
6661321
Compare
Build failed. ✔️ ansible-galaxy-importer SUCCESS in 5m 58s |
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 7m 12s |
Build succeeded. ✔️ ansible-galaxy-importer SUCCESS in 5m 37s |
a6d85e5
to
c26954a
Compare
Build succeeded (gate pipeline). ✔️ ansible-galaxy-importer SUCCESS in 5m 12s |
9429894
into
ansible-collections:main
Backport to stable-8: 💚 backport PR created✅ Backport PR branch: Backported as #2244 🤖 @patchback |
Update return block of ec2 modules (part 2) SUMMARY Refer #1983 This PR aligns the RETURN blocks in the module documentation to accurately reflect what the module returns, ensuring consistency. Modules updated: ec2_snapshot ec2_snapshot_info ec2_spot_instance ec2_vol ec2_vpc_endpoint ec2_vpc_endpoint_info ec2_vpc_endpoint_service_info ec2_vpc_nat_gateway ec2_vpc_nat_gateway_info ec2_vpc_route_table ec2_vpc_subnet ec2_vpc_subnet_info ISSUE TYPE Docs Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis Reviewed-by: GomathiselviS Reviewed-by: Bikouo Aubin Reviewed-by: Mike Graves <[email protected]> (cherry picked from commit 9429894)
This is a backport of PR #2079 as merged into main (9429894). SUMMARY Refer #1983 This PR aligns the RETURN blocks in the module documentation to accurately reflect what the module returns, ensuring consistency. Modules updated: ec2_snapshot ec2_snapshot_info ec2_spot_instance ec2_vol ec2_vpc_endpoint ec2_vpc_endpoint_info ec2_vpc_endpoint_service_info ec2_vpc_nat_gateway ec2_vpc_nat_gateway_info ec2_vpc_route_table ec2_vpc_subnet ec2_vpc_subnet_info ISSUE TYPE Docs Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Mark Chappell
SUMMARY
Refer #1983
This PR aligns the RETURN blocks in the module documentation to accurately reflect what the module returns, ensuring consistency.
Modules updated:
ec2_snapshot ec2_snapshot_info ec2_spot_instance ec2_vol ec2_vpc_endpoint ec2_vpc_endpoint_info ec2_vpc_endpoint_service_info ec2_vpc_nat_gateway ec2_vpc_nat_gateway_info ec2_vpc_route_table ec2_vpc_subnet ec2_vpc_subnet_info
ISSUE TYPE
COMPONENT NAME
ADDITIONAL INFORMATION