minor #12257 Yaml: minor syntax issues and expanded multi-line examples (javiereguiluz)

javiereguiluz · javiereguiluz · commit 96fed85a388b · 2019-09-02T16:52:24.000+02:00
This PR was merged into the 3.4 branch. Discussion ---------- Yaml: minor syntax issues and expanded multi-line examples Thanks to #12253 (created by @mikemix) I learned about this `>-` syntax ... so I think we should mention it. Commits ------- 79b0c49 Yaml: minor syntax issues and expanded multi-line examples
diff --git a/components/yaml/yaml_format.rst b/components/yaml/yaml_format.rst
@@ -94,9 +94,17 @@ where each line break is replaced by a space:
 
     >
       This is a very long sentence
-      that spans several lines in the YAML
-      but which will be rendered as a string
-      without carriage returns.
+      that spans several lines in the YAML.
+
+    # This will be parsed as follows: (notice the trailing \n)
+    # "This is a very long sentence that spans several lines in the YAML.\n"
+
+    >-
+      This is a very long sentence
+      that spans several lines in the YAML.
+
+    # This will be parsed as follows: (without a trailing \n)
+    # "This is a very long sentence that spans several lines in the YAML."
 
 .. note::
 
@@ -322,8 +330,8 @@ The following YAML features are not supported by the Symfony Yaml component:
 * Multi-documents (``---`` and ``...`` markers);
 * Complex mapping keys and complex values starting with ``?``;
 * Tagged values as keys;
-* The following tags and types: `!!set`, `!!omap`, `!!pairs`, `!!seq`,
-  `!!bool`, `!!int`, `!!merge`, `!!null`, `!!timestamp`, `!!value`, `!!yaml`;
+* The following tags and types: ``!!set``, ``!!omap``, ``!!pairs``, ``!!seq``,
+  ``!!bool``, ``!!int``, ``!!merge``, ``!!null``, ``!!timestamp``, ``!!value``, ``!!yaml``;
 * Tags (``TAG`` directive; example: ``%TAG ! tag:example.com,2000:app/``)
   and tag references (example: ``!<tag:example.com,2000:app/foo>``);
 * Using sequence-like syntax for mapping elements (example: ``{foo, bar}``; use
