ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Fix proper defaulting/required of 'state' for gem module

Browse source 
The docs for 'gem' say state is required, but the actual code says it's not required.

If it's not included (and there's no default) then the if block falls through with no changes and no errors (it neither adds nor removes the gem).

This change synchronizes the docs with the code.  It also adds the sane default of state=present, which is consistent with all other modules with the 'state' field.
This commit is contained in:
Drew 2014-02-12 11:31:11 -06:00
parent 4cd403247d
commit 44578e030d
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
library/packaging/gem
View file

@ -34,8 +34,9 @@ options:
state:
description:
- The desired state of the gem. C(latest) ensures that the latest version is installed.
required: true
required: false
choices: [present, absent, latest]
default: present
gem_source:
description:
- The path to a local gem used as installation source.
@ -186,7 +187,7 @@ def main():
include_dependencies = dict(required=False, default=True, type='bool'),
name = dict(required=True, type='str'),
repository = dict(required=False, aliases=['source'], type='str'),
state = dict(required=False, choices=['present','absent','latest'], type='str'),
state = dict(required=False, default='present', choices=['present','absent','latest'], type='str'),
user_install = dict(required=False, default=True, type='bool'),
version = dict(required=False, type='str'),
),