From 54800ea47c21ac920efca23e332438e982bbc996 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Mon, 9 Jan 2017 20:18:15 -0500 Subject: [PATCH] better sections for module return docs --- docs/docsite/rst/common_return_values.rst | 14 +++++++++----- 1 file 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.