equinix-labs / ansible-collection-equinix

Ansible content to help automate the management of Equinix resources
https://deploy.equinix.com/labs/ansible-collection-equinix/
GNU General Public License v3.0
2 stars 8 forks source link

docs: document return_values specification in specdoc #174

Closed t0mk closed 3 months ago

t0mk commented 3 months ago

This PR adds development docs on how to specify return value example of a module. We had to fix this because of ansible-specdoc and ansible-doc, and @ctreatma asked for the return value spec to be documented.

Rendered it looks like this: https://github.com/equinix-labs/ansible-collection-equinix/blob/document_return_value_docs_specification/DEVELOPMENT.md#22-documentation-and-the-specdoc-fields

displague commented 3 months ago

Noting that the unrelated failed/flaked test is captured in https://github.com/equinix-labs/ansible-collection-equinix/issues/177

github-actions[bot] commented 3 months ago

This PR is included in version 0.4.1 :tada: