Skip to content

Commit fe45194

Browse files
committed
Added a note about the lacking features of Yaml Component
1 parent 7cbad6d commit fe45194

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

components/yaml/introduction.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@
22
single: Yaml
33
single: Components; Yaml
44

5-
The YAML Component
5+
The Yaml Component
66
==================
77

8-
The YAML Component loads and dumps YAML files.
8+
The Yaml Component loads and dumps YAML files.
99

1010
What is It?
1111
-----------
1212

13-
The Symfony2 YAML Component parses YAML strings to convert them to PHP arrays.
13+
The Symfony2 Yaml Component parses YAML strings to convert them to PHP arrays.
1414
It is also able to convert PHP arrays to YAML strings.
1515

1616
`YAML`_, *YAML Ain't Markup Language*, is a human friendly data serialization
1717
standard for all programming languages. YAML is a great format for your
1818
configuration files. YAML files are as expressive as XML files and as readable
1919
as INI files.
2020

21-
The Symfony2 YAML Component implements the YAML 1.2 version of the
22-
specification.
21+
The Symfony2 Yaml Component implements a selected subset of features defined in
22+
the `YAML 1.2 version specification`_.
2323

2424
.. tip::
2525

@@ -40,8 +40,10 @@ Why?
4040
Fast
4141
~~~~
4242

43-
One of the goal of Symfony YAML is to find the right balance between speed and
44-
features. It supports just the needed feature to handle configuration files.
43+
One of the goals of Symfony Yaml is to find the right balance between speed and
44+
features. It supports just the needed features to handle configuration files.
45+
Notable lacking features are: document directives, multi-line quoted messages,
46+
compact block collections and multi-document files.
4547

4648
Real Parser
4749
~~~~~~~~~~~
@@ -78,7 +80,7 @@ yourself by referencing common configuration bits.
7880
Using the Symfony2 YAML Component
7981
---------------------------------
8082

81-
The Symfony2 YAML Component is very simple and consists of two main classes:
83+
The Symfony2 Yaml Component is very simple and consists of two main classes:
8284
one parses YAML strings (:class:`Symfony\\Component\\Yaml\\Parser`), and the
8385
other dumps a PHP array to a YAML string
8486
(:class:`Symfony\\Component\\Yaml\\Dumper`).
@@ -163,7 +165,7 @@ array to its YAML representation:
163165
164166
.. note::
165167

166-
Of course, the Symfony2 YAML dumper is not able to dump resources. Also,
168+
Of course, the Symfony2 Yaml dumper is not able to dump resources. Also,
167169
even if the dumper is able to dump PHP objects, it is considered to be a
168170
not supported feature.
169171

@@ -213,3 +215,4 @@ representation to the inline one:
213215
214216
.. _YAML: http://yaml.org/
215217
.. _Packagist: https://packagist.org/packages/symfony/yaml
218+
.. _`YAML 1.2 version specification`: http://yaml.org/spec/1.2/spec.html

0 commit comments

Comments
 (0)