From 6d003ca7fcb0bca3cddb93d80de9cced26452803 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Jeanneret?= <39397510+cjeanner@users.noreply.github.com> Date: Wed, 8 Mar 2023 14:16:45 +0100 Subject: [PATCH] [make] Improve module doc (#6161) This change reorder the parameters so that we get the mandatory one at the top, then alphabetically order the other bellow. It also adds the returned values. --- plugins/modules/make.py | 56 ++++++++++++++++++++++++++++++----------- 1 file changed, 41 insertions(+), 15 deletions(-) diff --git a/plugins/modules/make.py b/plugins/modules/make.py index be2a32bd45..ec19b367c3 100644 --- a/plugins/modules/make.py +++ b/plugins/modules/make.py @@ -25,15 +25,6 @@ attributes: diff_mode: support: none options: - target: - description: - - The target to run. - - Typically this would be something like C(install),C(test) or C(all)." - type: str - params: - description: - - Any extra parameters to pass to make. - type: dict chdir: description: - Change to this directory before running make. @@ -43,11 +34,6 @@ options: description: - Use a custom Makefile. type: path - make: - description: - - Use a specific make binary. - type: path - version_added: '0.2.0' jobs: description: - Set the number of make jobs to run concurrently. @@ -55,6 +41,20 @@ options: - This is not supported by all make implementations. type: int version_added: 2.0.0 + make: + description: + - Use a specific make binary. + type: path + version_added: '0.2.0' + params: + description: + - Any extra parameters to pass to make. + type: dict + target: + description: + - The target to run. + - Typically this would be something like C(install), C(test), or C(all). + type: str ''' EXAMPLES = r''' @@ -83,7 +83,33 @@ EXAMPLES = r''' file: /some-project/Makefile ''' -RETURN = r'''# ''' +RETURN = r''' +chdir: + description: + - The value of the module parameter I(chdir). + type: str + returned: success +file: + description: + - The value of the module parameter I(file). + type: str + returned: success +jobs: + description: + - The value of the module parameter I(jobs) + type: int + returned: success +params: + description: + - The value of the module parameter I(params) + type: dict + returned: success +target: + description: + - The value of the module parameter I(target) + type: str + returned: success +''' from ansible.module_utils.six import iteritems from ansible.module_utils.basic import AnsibleModule