diff options
| author | @skg_net <skg.net.dev@gmail.com> | 2016-08-25 11:57:57 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-08-25 11:57:57 -0700 |
| commit | a76e39a2b05d5a39760ea7a6e1b7d455e992ef32 (patch) | |
| tree | fcba0a178d4d25633245f5e3c13859da6ce7cdf9 | |
| parent | 2dd5e13098b109c45105c9251c12b516ca9f505c (diff) | |
| parent | 35a3653dfcaf1d5de8825c015ed1ae69425f5ee7 (diff) | |
| download | ansible-a76e39a2b05d5a39760ea7a6e1b7d455e992ef32.tar.gz | |
Merge pull request #1 from ansible/devel
Merge to latest upstream
| -rw-r--r-- | docsite/rst/developing_modules.rst | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/docsite/rst/developing_modules.rst b/docsite/rst/developing_modules.rst index b212cb588d..d7a5ba7ecb 100644 --- a/docsite/rst/developing_modules.rst +++ b/docsite/rst/developing_modules.rst @@ -721,7 +721,14 @@ The following checklist items are important guidelines for people who want to c fields of a dictionary and return the dictionary. * When fetching URLs, please use either fetch_url or open_url from ansible.module_utils.urls rather than urllib2; urllib2 does not natively verify TLS certificates and so is insecure for https. - +* facts modules must return facts in the ansible_facts field of the result + dictionary. :ref:`module_provided_facts` +* modules that are purely about fact gathering need to implement check_mode. + they should not cause any changes anyway so it should be as simple as adding + check_mode=True when instantiating AnsibleModule. (The reason is that + playbooks which conditionalize based on fact information will only + conditionalize correctly in check_mode if the facts are returned in + check_mode). Windows modules checklist ````````````````````````` |