airship/deckhand
Code Issues Proposed changes

docs: Distinguish replace layering action from document replacement

Browse Source 
Add a blurb to the replacement documentation that differentiates
the layering replace action from document replacement to avoid
conflation of the terms.

Change-Id: Ie3da4645c5fa4ed0eab95184443acbb01c5b2740
This commit is contained in:
Felipe Monteiro 2018-04-09 18:48:18 +01:00 committed by Anthony Lin
parent e23f46c152
commit 6b9cd17e98
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/source/replacement.rst
View File

@ -30,6 +30,11 @@ replacing its *parent*. That is, the *entire* child document replaces its
parent document. Replacement aims to lessen data duplication by taking
advantage of :ref:`document-abstraction` and document layering patterns.
Unlike the :ref:`layering` ``replace`` action, which allows a child document
to selectively replace portions of the parent's ``data`` section with that of
its own, document replacement allows a child document to replace the *entire*
parent document.
.. todo::
Elaborate on these patterns in a separate section.