From ea5cd3941bf7d63d2ee8f6a85ebeb587d9531eff Mon Sep 17 00:00:00 2001 From: Ryan Brown Date: Fri, 29 Jul 2016 12:31:55 -0400 Subject: [PATCH] Improve module docs (#2638) --- .../extras/source_control/github_key.py | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/lib/ansible/modules/extras/source_control/github_key.py b/lib/ansible/modules/extras/source_control/github_key.py index fb5f8f86562..815be9dc94b 100644 --- a/lib/ansible/modules/extras/source_control/github_key.py +++ b/lib/ansible/modules/extras/source_control/github_key.py @@ -54,18 +54,20 @@ author: Robert Estelle (@erydo) RETURN = ''' deleted_keys: - description: Keys that were deleted, if any. - returned: When state=absent + description: An array of key objects that were deleted. Only present on state=absent type: list - + returned: When state=absent + sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': False}] matching_keys: - description: Keys that match the specified name. - returned: When state=present + description: An array of keys matching the specified name. Only present on state=present type: list - + returned: When state=present + sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': False}] key: - description: The key created. - returned: When state=present and a new key is created. + description: Metadata about the key just created. Only present on state=present + type: dict + returned: success + sample: {'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': False} ''' EXAMPLES = '''