Skip to content

Commit 2fe8f76

Browse files
committed
minor #5044 Minor improvement in the node types explanation (javiereguiluz)
This PR was merged into the 2.3 branch. Discussion ---------- Minor improvement in the node types explanation | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | 2.3+ | Fixed tickets | - Commits ------- 987f5a5 "enum" is similar to "scalar", not "array" 96c423a Moved the admonition about the INI loader to the loaders section c774b8a Improved a bit the information about dumping config daff271 Minor improvement in the node types explanation
2 parents 9b1f5f1 + 987f5a5 commit 2fe8f76

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

Diff for: components/config/definition.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,13 @@ Node Type
9595
~~~~~~~~~
9696

9797
It is possible to validate the type of a provided value by using the appropriate
98-
node definition. Node type are available for:
98+
node definition. Node types are available for:
9999

100-
* scalar
100+
* scalar (generic type that includes booleans, strings, integers, floats and ``null``)
101101
* boolean
102102
* integer (new in 2.2)
103103
* float (new in 2.2)
104-
* enum (new in 2.1)
104+
* enum (new in 2.1) (similar to scalar, but it only allows a finite set of values)
105105
* array
106106
* variable (no validation)
107107

@@ -294,7 +294,8 @@ All options can be documented using the
294294
:method:`Symfony\\Component\\Config\\Definition\\Builder\\NodeDefinition::info`
295295
method.
296296

297-
The info will be printed as a comment when dumping the configuration tree.
297+
The info will be printed as a comment when dumping the configuration tree with
298+
the ``config:dump`` command.
298299

299300
Optional Sections
300301
-----------------

Diff for: components/config/introduction.rst

-7
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,6 @@ The Config Component
99
combine, autofill and validate configuration values of any kind, whatever
1010
their source may be (YAML, XML, INI files, or for instance a database).
1111

12-
.. caution::
13-
14-
The ``IniFileLoader`` parses the file contents using the
15-
:phpfunction:`parse_ini_file` function, therefore, you can only set
16-
parameters to string values. To set parameters to other data types
17-
(e.g. boolean, integer, etc), the other loaders are recommended.
18-
1912
Installation
2013
------------
2114

Diff for: components/config/resources.rst

+7
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Loading Resources
55
=================
66

7+
.. caution::
8+
9+
The ``IniFileLoader`` parses the file contents using the
10+
:phpfunction:`parse_ini_file` function. Therefore, you can only set
11+
parameters to string values. To set parameters to other data types
12+
(e.g. boolean, integer, etc), the other loaders are recommended.
13+
714
Locating Resources
815
------------------
916

0 commit comments

Comments
 (0)