Uploaded image for project: 'Ansible Cloud Automation'
  1. Ansible Cloud Automation
  2. ACA-1625

[vmware.vmware_rest/337] some modules have odd formatting in the short description

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False

      https://github.com/ansible-collections/vmware.vmware_rest/issues/337
      <!--- Verify first that your improvement is not already reported on GitHub -->
      <!--- Also test if the latest release and devel branch are affected too -->
      <!--- Complete all sections as described, this form is processed automatically -->

              1. SUMMARY
                <!--- Explain the problem briefly below, add suggestions to wording or structure -->
                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.
      <!--- HINT: Did you know the documentation has an "Edit on GitHub" link on every page ? -->

      Initial discussion reveals:

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

              1. ISSUE TYPE
      • Documentation Report
              1. COMPONENT NAME
                <!--- Write the short name of the rst file, module, plugin, task or feature below, use your best guess if unsure -->
                https://github.com/ansible-collections/vmware.vmware_rest/blame/main/plugins/modules/vcenter_cluster_info.py
              1. ANSIBLE VERSION
                <!--- Paste verbatim output from "ansible --version" between quotes -->
                ```paste below
                2.13
                ```

            Unassigned Unassigned
            gosriniv@redhat.com Gomathi selvi Srinivasan
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: