ovirt-ansible-collection icon indicating copy to clipboard operation
ovirt-ansible-collection copied to clipboard

Improving "ovirt_disk" (mostly documentation)

Open barpavel opened this issue 2 years ago • 2 comments

  1. Improving ovirt_disk documentation comments (minor rephrasing + typos). WIP

barpavel avatar Jul 17 '22 10:07 barpavel

@barpavel Anything else missing? If not, then please move the PR to review ...

mwperina avatar Aug 03 '22 07:08 mwperina

@barpavel Anything else missing? If not, then please move the PR to review ...

Yes, there were few more things I wanted to add, the PR is not finished. I will try to finish it this week.

barpavel avatar Aug 03 '22 09:08 barpavel

Actually one of the reasons this PR started, was that I saw the following strange documentation, see https://docs.ansible.com/ansible/latest/collections/ovirt/ovirt/ovirt_disk_module.html

bootable boolean

True if the disk should be bootable. By default when disk is created it isn’t bootable.
Choices:
no
yes

I mean pay attention to the text that requires True vs. Choices that have other enum values: yes /no.... I wanted to fix that but I'm not sure should I and how...

barpavel avatar Nov 15 '22 09:11 barpavel

Actually one of the reasons this PR started, was that I saw the following strange documentation, see https://docs.ansible.com/ansible/latest/collections/ovirt/ovirt/ovirt_disk_module.html

bootable boolean

True if the disk should be bootable. By default when disk is created it isn’t bootable.
Choices:
no
yes

I mean pay attention to the text that requires True vs. Choices that have other enum values: yes /no.... I wanted to fix that but I'm not sure should I and how...

@mnecas @mwperina What do you think?

barpavel avatar Nov 15 '22 09:11 barpavel