vmware.vmware_rest icon indicating copy to clipboard operation
vmware.vmware_rest copied to clipboard

some modules have odd formatting in the short description

Open samccann opened this issue 2 years ago • 0 comments

SUMMARY

Some modules have the following in their short description:

Retrieves information about the cluster corresponding to {@param.name cluster} The {@param.name cluster} seems odd and there are 9 examples of these odd short descriptions.

This shows up in Automation Hub as well as docs.ansible.com.

Initial discussion reveals:

The documentation is autogenerated and it looks like some artifacts remain from the original API documentation.

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

https://github.com/ansible-collections/vmware.vmware_rest/blame/main/plugins/modules/vcenter_cluster_info.py

ANSIBLE VERSION
2.13

samccann avatar Jun 13 '22 18:06 samccann