summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Coca <brian.coca+git@gmail.com>2017-01-09 20:18:15 -0500
committerBrian Coca <brian.coca+git@gmail.com>2017-01-09 20:18:30 -0500
commit54800ea47c21ac920efca23e332438e982bbc996 (patch)
tree578db51241302accea0c96e785bafeca3efae86a
parentcc3d131f503b34ae972dbed94a0b5fde567aab92 (diff)
downloadansible-54800ea47c21ac920efca23e332438e982bbc996.tar.gz
better sections for module return docs
-rw-r--r--docs/docsite/rst/common_return_values.rst14
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.