cloud-init-dev team mailing list archive

[David Tagatac <david@xxxxxxxxxxx>]

A more useful diff:
$ git --no-pager diff master:doc/merging.rst doc/rtd/topics/merging.rst
diff --git a/doc/rtd/topics/merging.rst b/doc/rtd/topics/merging.rst
index bf49b909..2f927a47 100644
--- a/doc/rtd/topics/merging.rst
+++ b/doc/rtd/topics/merging.rst
@@ -1,3 +1,7 @@
+**************************
+Merging User-Data Sections
+**************************
+
 Overview
 ========
 
@@ -8,9 +12,9 @@ performing an #include).
 
 Since previously the merging algorithm was very simple and would only overwrite
 and not append lists, or strings, and so on it was decided to create a new and
-improved way to merge dictionaries (and there contained objects) together in a
+improved way to merge dictionaries (and their contained objects) together in a
 way that is customizable, thus allowing for users who provide cloud-config
-user-data to determine exactly how there objects will be merged.
+user-data to determine exactly how their objects will be merged.
 
 For example.
 
@@ -26,7 +30,7 @@ For example.
      - bash3
      - bash4
 
-The previous way of merging the following 2 objects would result in a final
+The previous way of merging the two objects above would result in a final
 cloud-config object that contains the following.
 
 .. code-block:: yaml
@@ -36,7 +40,7 @@ cloud-config object that contains the following.
      - bash3
      - bash4
 
-Typically this is not what users want, instead they would likely prefer:
+Typically this is not what users want; instead they would likely prefer:
 
 .. code-block:: yaml
 
@@ -48,18 +52,17 @@ Typically this is not what users want, instead they would likely prefer:
      - bash4
 
 This way makes it easier to combine the various cloud-config objects you have
-into a more useful list, thus reducing duplication that would have had to
-occur in the previous method to accomplish the same result.
+into a more useful list, thus reducing duplication necessary to accomplish the
+same result with the previous method.
 
 Customizability
 ===============
 
-Since the above merging algorithm may not always be the desired merging
-algorithm (like how the previous merging algorithm was not always the preferred
-one) the concept of customizing how merging can be done was introduced through
-a new concept call 'merge classes'.
+Because the above merging algorithm may not always be desired (just as the
+previous merging algorithm was not always the preferred one), the concept of
+customized merging was introduced through 'merge classes'.
 
-A merge class is a class defintion which provides functions that can be used
+A merge class is a class definition which provides functions that can be used
 to merge a given type with another given type.
 
 An example of one of these merging classes is the following:
@@ -156,8 +159,8 @@ following:
 Dictionary format
 -----------------
 
-In cases where a dictionary can be used to specify the same information as the
-string format (ie option #2 of above) it can be used, for example.
+A dictionary can be used when it specifies the same information as the
+string format (i.e. the second option above), for example:
 
 .. code-block:: python
 

-- 
https://code.launchpad.net/~tagatac/cloud-init/+git/cloud-init/+merge/322239
Your team cloud init development team is requested to review the proposed merge of ~tagatac/cloud-init:docs into cloud-init:master.