diff options
author | Brian Coca <brian.coca+git@gmail.com> | 2017-01-09 20:18:15 -0500 |
---|---|---|
committer | Brian Coca <brian.coca+git@gmail.com> | 2017-01-09 20:18:30 -0500 |
commit | 54800ea47c21ac920efca23e332438e982bbc996 (patch) | |
tree | 578db51241302accea0c96e785bafeca3efae86a | |
parent | cc3d131f503b34ae972dbed94a0b5fde567aab92 (diff) | |
download | ansible-54800ea47c21ac920efca23e332438e982bbc996.tar.gz |
better sections for module return docs
-rw-r--r-- | docs/docsite/rst/common_return_values.rst | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/docsite/rst/common_return_values.rst b/docs/docsite/rst/common_return_values.rst index c509a522e3..9aad6fa1fa 100644 --- a/docs/docsite/rst/common_return_values.rst +++ b/docs/docsite/rst/common_return_values.rst @@ -1,7 +1,5 @@ -.. _common_return_values: - -Common Return Values --------------------- +Return Values +------------- .. contents:: Topics @@ -13,6 +11,10 @@ This document covers return values common to all modules. .. note:: Some of these keys might be set by Ansible itself once it processes the module's return information. +.. _common_return_values: + +Common +^^^^^^ backup_file ``````````` @@ -63,8 +65,10 @@ stdout_lines When c(stdout) is returned, Ansible always provides a list of strings, each containing one item per line from the original output. +.. _internal_return_values: + Internal use ------------- +^^^^^^^^^^^^ These keys can be added by modules but will be removed from registered variables; they are 'consumed' by Ansible itself. |