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

Add RETURN docs for the pip module (#39907)

The pip module returns some things. Let's document them.
This commit is contained in:
David Moreau Simard 2018-06-19 13:34:14 -04:00 committed by ansibot
parent 52acec3455
commit 89a9fb79da

View file

@ -190,6 +190,34 @@ EXAMPLES = '''
become: True
'''
RETURN = '''
cmd:
description: pip command used by the module
returned: success
type: string
sample: pip2 install ansible six
name:
description: list of python modules targetted by pip
returned: success
type: list
sample: ['ansible', 'six']
requirements:
description: Path to the requirements file
returned: success, if a requirements file was provided
type: string
sample: "/srv/git/project/requirements.txt"
version:
description: Version of the package specified in 'name'
returned: success, if a name and version were provided
type: string
sample: "2.5.1"
virtualenv:
description: Path to the virtualenv
returned: success, if a virtualenv path was provided
type: string
sample: "/tmp/virtualenv"
'''
import os
import re
import sys