From 6f77dbf66f093a7c51ccc13e1c12cc11cebf0954 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Thu, 21 Mar 2019 13:49:28 -0400 Subject: [PATCH] update _facts and _info in checklist (#54182) * update _facts and _info in checklist in docs/docsite/rst/dev_guide/developing_modules_checklist.rst Co-Authored-By: bcoca --- docs/docsite/rst/dev_guide/developing_modules_checklist.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docsite/rst/dev_guide/developing_modules_checklist.rst b/docs/docsite/rst/dev_guide/developing_modules_checklist.rst index 52573b0a4a0..6b1b9e0a312 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_checklist.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_checklist.rst @@ -24,7 +24,8 @@ To contribute a module to Ansible, you must: * minimize module dependencies * support :ref:`check_mode ` if possible * ensure your code is readable -* if a module is named `_facts`, it is because it is returning `ansible_facts`. Do not name modules that do not do this with `_facts`. +* if a module is named ``_facts``, it should be because its main purpose is returning ``ansible_facts``. Do not name modules that do not do this with ``_facts``. +* Modules that query/return general information (and not ``ansible_facts``) should be named ``_info``. Please make sure your module meets these requirements before you submit your PR/proposal. If you have questions, reach out via `Ansible's IRC chat channel `_ or the `Ansible development mailing list `_.