From e930e3d42a3601d646eb8fe999b0019ffe42c7a9 Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Sun, 31 Aug 2025 12:10:47 +0200 Subject: [PATCH] [PR #10770/3cc4f28f backport][stable-9] minor fixes in doc guides (#10778) minor fixes in doc guides (#10770) (cherry picked from commit 3cc4f28fd792025828caa9854d81adc2cfdff96d) Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> --- docs/docsite/rst/guide_deps.rst | 1 + docs/docsite/rst/guide_modulehelper.rst | 7 ++++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/docsite/rst/guide_deps.rst b/docs/docsite/rst/guide_deps.rst index 4c0c4687a4..1a44051ee4 100644 --- a/docs/docsite/rst/guide_deps.rst +++ b/docs/docsite/rst/guide_deps.rst @@ -22,6 +22,7 @@ The same example from the Developer Guide would become: from ansible_collections.community.general.plugins.module_utils import deps + with deps.declare("foo"): import foo diff --git a/docs/docsite/rst/guide_modulehelper.rst b/docs/docsite/rst/guide_modulehelper.rst index 68b46e6c94..01750f9a89 100644 --- a/docs/docsite/rst/guide_modulehelper.rst +++ b/docs/docsite/rst/guide_modulehelper.rst @@ -75,6 +75,7 @@ section above, but there are more elements that will take part in it. from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper + class MyTest(ModuleHelper): output_params = () change_params = () @@ -256,9 +257,9 @@ With that, MH will automatically generate the diff output for variables that hav class MyTest(ModuleHelper): diff_params = ('value', ) - def __run__(self): - # example from community.general.gio_mime - self.vars.set_meta("handler", initial_value=gio_mime_get(self.runner, self.vars.mime_type), diff=True, change=True) + def __run__(self): + # example from community.general.gio_mime + self.vars.set_meta("handler", initial_value=gio_mime_get(self.runner, self.vars.mime_type), diff=True, change=True) Moreover, if a module is set to return *facts* instead of return values, then again use the metadata ``fact=True`` and ``fact_params`` for module parameters. Additionally, you must specify ``facts_name``, as in: