Warn about upcoming API changes to certain concepts

2017-11-11 09:13:05 -08:00
1 parent 082767adfc
commit afca4cc277
@@ -1,3 +1,9 @@
+Version 142:
+
+* Warn about upcoming API changes to certain concepts
+
+--------------------------------------------------------------------------------
+
 Version 141:

 * Tidy up some documentation
@@ -29,6 +29,11 @@ representation:

 [heading Requirements]

+[warning
+    These requirements may undergo non-backward compatible
+    changes in subsequent versions.
+]
+
 In this table:

 * `R` denotes a type meeting the requirements of [*BodyReader].
@@ -31,6 +31,11 @@ intended to obtain buffers for these scenarios:

 [heading Requirements]

+[warning
+    These requirements may undergo non-backward compatible
+    changes in subsequent versions.
+]
+
 In this table:

 * `W` denotes a type meeting the requirements of [*BodyWriter].
@@ -22,6 +22,11 @@ be serialized.

 [heading Requirements]

+[warning
+    These requirements may undergo non-backward compatible
+    changes in subsequent versions.
+]
+
 In this table:

 * `F` denotes a type that meets the requirements of [*Fields].
@@ -20,6 +20,11 @@ calls into it once to retrieve the buffers.

 [heading Requirements]

+[warning
+    These requirements may undergo non-backward compatible
+    changes in subsequent versions.
+]
+
 In this table:

 * `W` denotes a type that meets the requirements of [*FieldsWriter].