win_chocolatey - Improve docs around install_args and package_params #89
Labels
5 - Released
The issue has been resolved, and released to the public for consumption
Documentation
Issues for changes that only need to change documentation
Milestone
Is Your Feature Request Related To A Problem? Please describe.
The documentation around
install_args
andpackage_params
is not particularly clear as to when one should be used over the other.install_args:
chocolatey-ansible/chocolatey/plugins/modules/win_chocolatey.py
Lines 111 to 117 in 85ee7fd
package_params:
chocolatey-ansible/chocolatey/plugins/modules/win_chocolatey.py
Lines 133 to 141 in 85ee7fd
Describe The Solution. Why is it needed?
This came up in the Chocolatey Discord, a user was trying to use
install_args
to pass package parameters, as the documentation around these two options is not super clear.Quote:
We should likely pull from Chocolatey's own command/option documentation and make the difference between these much more evident. Users should be able to infer from the options documentation that when passing parameters to a package install script, they should be using
package_params
, and when passing custom parameters to the underlying MSI/EXE/etc that a package might be running, they should be usinginstall_args
.Additional Context.
N/A
Related Issues
N/A
The text was updated successfully, but these errors were encountered: