Skip to content

Commit ce6e3eb

Browse files
committed
Reworded some explanations to make them more clear
1 parent caaa272 commit ce6e3eb

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

components/yaml/yaml_format.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ must be doubled to escape it:
4545
4646
'A single quote '' inside a single-quoted string'
4747
48-
If the string contains any of the following characters, it must be escaped with
49-
single quotes:
48+
Strings containing any of the following characters must be quoted. Although you
49+
can use double quotes, for these characters is more convenient to use single
50+
quotes, which avoids having to escape any backslash ``\``:
5051

5152
* ``:``
5253
* ``{``
@@ -69,16 +70,15 @@ single quotes:
6970
* ``\```
7071

7172
The double-quoted style provides a way to express arbitrary strings, by
72-
using ``\`` escape sequences. It is very useful when you need to embed a
73-
``\n`` or a Unicode character in a string.
73+
using ``\`` to escape characters and sequences. For instance, it is very useful
74+
when you need to embed a ``\n`` or a Unicode character in a string.
7475

7576
.. code-block:: yaml
7677
7778
"A double-quoted string in YAML\n"
7879
7980
If the string contains any of the following control characters, it must be
80-
escaped with double quotes. In addition, the escaping must use a double slash
81-
``\\`` to avoid parsing issues:
81+
escaped with double quotes:
8282

8383
* ``\0``
8484
* ``\x01``

0 commit comments

Comments
 (0)