plugins documentation enhancement #1983
Comments
|
It may be worth investigating whether we could use type hinting on the result dictionary to ensure the RETURN block is always up to date. |
softwarefactory-project-zuul bot
pushed a commit
that referenced
this issue
May 7, 2024
Update return block in documentation for ec2 modules (part 1) 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_eip_info, ec2_ami, ec2_ami_info, ec2_eni, ec2_eni_info, ec2_instance, ec2_instance_info, ec2_security_group, ec2_security_group_info ISSUE TYPE Docs Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis Reviewed-by: Mark Chappell Reviewed-by: Mike Graves <[email protected]>
softwarefactory-project-zuul bot
pushed a commit
that referenced
this issue
May 21, 2024
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]>
patchback bot
pushed a commit
that referenced
this issue
Aug 27, 2024
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)
softwarefactory-project-zuul bot
pushed a commit
that referenced
this issue
Aug 27, 2024
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Summary
Some plugins receive more frequent updates than others. This means that it can happen that some plugins return undocumented information in the RETURN block. This situation can also occur when updating botocore versions between major collections.
To ensure that our modules have an up-to-date RETURN block, I would suggest considering each plugin in part and making sure that the document's RETURN block is consistent with what the module actually returns.
Issue Type
Documentation Report
Component Name
Several
Ansible Version
$ ansible --versionCollection Versions
$ ansible-galaxy collection listConfiguration
No response
OS / Environment
No response
Additional Information
No response
Code of Conduct
The text was updated successfully, but these errors were encountered: