From 53e7e48834bb9b5dcb4d738186c744444d832917 Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Mon, 22 Mar 2021 20:55:37 +0100 Subject: [PATCH] improve force_archive parameter documentation of archive module (#2052) (#2079) * improve documentation for force_archive parameter * add link to unarchive module Co-authored-by: Felix Fontein Co-authored-by: Felix Fontein (cherry picked from commit af441aecfcc59e38f6ea87a35c2a66adc64b8f6c) Co-authored-by: Triantafyllos --- plugins/modules/files/archive.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/plugins/modules/files/archive.py b/plugins/modules/files/archive.py index 98bcbf3605..e071c1bced 100644 --- a/plugins/modules/files/archive.py +++ b/plugins/modules/files/archive.py @@ -44,8 +44,9 @@ options: elements: path force_archive: description: - - Allow you to force the module to treat this as an archive even if only a single file is specified. - - By default behaviour is maintained. i.e A when a single file is specified it is compressed only (not archived). + - Allows you to force the module to treat this as an archive even if only a single file is specified. + - By default when a single file is specified it is compressed only (not archived). + - Enable this if you want to use M(ansible.builtin.unarchive) on an archive of a single file created with this module. type: bool default: false remove: