Skip to content

Commit 1191dee

Browse files
committed
Fix proper nouns and some formatting
1 parent 0eb2531 commit 1191dee

40 files changed

+137
-137
lines changed

book/doctrine.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1485,7 +1485,7 @@ and ``nullable``. Take a few examples:
14851485
fields:
14861486
# A string field length 255 that cannot be null
14871487
# (reflecting the default values for the "length" and *nullable* options)
1488-
# type attribute is necessary in yaml definitions
1488+
# type attribute is necessary in YAML definitions
14891489
name:
14901490
type: string
14911491
@@ -1502,7 +1502,7 @@ and ``nullable``. Take a few examples:
15021502
<!--
15031503
A string field length 255 that cannot be null
15041504
(reflecting the default values for the "length" and *nullable* options)
1505-
type attribute is necessary in xml definitions
1505+
type attribute is necessary in XML definitions
15061506
-->
15071507
<field name="name" type="string" />
15081508
<field name="email"

book/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,11 +321,11 @@ Using Source Control
321321

322322
If you're using a version control system like ``Git`` or ``Subversion``, you
323323
can setup your version control system and begin committing your project to
324-
it as normal. The Symfony Standard edition *is* the starting point for your
324+
it as normal. The Symfony Standard Edition *is* the starting point for your
325325
new project.
326326

327327
For specific instructions on how best to setup your project to be stored
328-
in git, see :doc:`/cookbook/workflow/new_project_git`.
328+
in Git, see :doc:`/cookbook/workflow/new_project_git`.
329329

330330
Ignoring the ``vendor/`` Directory
331331
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

book/page_creation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -854,7 +854,7 @@ options of each feature.
854854
three formats (YAML, XML and PHP). Each has its own advantages and
855855
disadvantages. The choice of which to use is up to you:
856856

857-
* *YAML*: Simple, clean and readable (learn more about yaml in
857+
* *YAML*: Simple, clean and readable (learn more about YAML in
858858
":doc:`/components/yaml/yaml_format`");
859859

860860
* *XML*: More powerful than YAML at times and supports IDE autocompletion;
@@ -867,7 +867,7 @@ Default Configuration Dump
867867
.. versionadded:: 2.1
868868
The ``config:dump-reference`` command was added in Symfony 2.1
869869

870-
You can dump the default configuration for a bundle in yaml to the console using
870+
You can dump the default configuration for a bundle in YAML to the console using
871871
the ``config:dump-reference`` command. Here is an example of dumping the default
872872
FrameworkBundle configuration:
873873

book/service_container.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -255,8 +255,8 @@ looks up the value of each parameter and uses it in the service definition.
255255
.. note::
256256

257257
If you want to use a string that starts with an ``@`` sign as a parameter
258-
value (i.e. a very safe mailer password) in a yaml file, you need to escape
259-
it by adding another ``@`` sign (This only applies to the YAML format):
258+
value (i.e. a very safe mailer password) in a YAML file, you need to escape
259+
it by adding another ``@`` sign (this only applies to the YAML format):
260260

261261
.. code-block:: yaml
262262

components/config/definition.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ and their structure can be validated using the "Definition" part of the Config
1212
Component. Configuration values are usually expected to show some kind of
1313
hierarchy. Also, values should be of a certain type, be restricted in number
1414
or be one of a given set of values. For example, the following configuration
15-
(in Yaml) shows a clear hierarchy and some validation rules that should be
15+
(in YAML) shows a clear hierarchy and some validation rules that should be
1616
applied to it (like: "the value for ``auto_connect`` must be a boolean value"):
1717

1818
.. code-block:: yaml
@@ -396,19 +396,19 @@ Normalization
396396
When the config files are processed they are first normalized, then merged
397397
and finally the tree is used to validate the resulting array. The normalization
398398
process is used to remove some of the differences that result from different
399-
configuration formats, mainly the differences between Yaml and XML.
399+
configuration formats, mainly the differences between YAML and XML.
400400

401-
The separator used in keys is typically ``_`` in Yaml and ``-`` in XML. For
402-
example, ``auto_connect`` in Yaml and ``auto-connect``. The normalization would
401+
The separator used in keys is typically ``_`` in YAML and ``-`` in XML. For
402+
example, ``auto_connect`` in YAML and ``auto-connect``. The normalization would
403403
make both of these ``auto_connect``.
404404

405405
.. caution::
406406

407407
The target key will not be altered if it's mixed like
408408
``foo-bar_moo`` or if it already exists.
409409

410-
Another difference between Yaml and XML is in the way arrays of values may
411-
be represented. In Yaml you may have:
410+
Another difference between YAML and XML is in the way arrays of values may
411+
be represented. In YAML you may have:
412412

413413
.. code-block:: yaml
414414
@@ -447,7 +447,7 @@ a second argument::
447447
->end()
448448
;
449449

450-
As well as fixing this, ``fixXmlConfig`` ensures that single xml elements
450+
As well as fixing this, ``fixXmlConfig`` ensures that single XML elements
451451
are still turned into an array. So you may have:
452452

453453
.. code-block:: xml

components/config/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Introduction
1010

1111
The Config Component provides several classes to help you find, load, combine,
1212
autofill and validate configuration values of any kind, whatever their source
13-
may be (Yaml, XML, INI files, or for instance a database).
13+
may be (YAML, XML, INI files, or for instance a database).
1414

1515
Installation
1616
------------

components/config/resources.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ all matches.
2727
Resource loaders
2828
----------------
2929

30-
For each type of resource (Yaml, XML, annotation, etc.) a loader must be defined.
30+
For each type of resource (YAML, XML, annotation, etc.) a loader must be defined.
3131
Each loader should implement :class:`Symfony\\Component\\Config\\Loader\\LoaderInterface`
3232
or extend the abstract :class:`Symfony\\Component\\Config\\Loader\\FileLoader`
3333
class, which allows for recursively importing other resources::

components/dependency_injection/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Setting Up the Container with Configuration Files
179179
-------------------------------------------------
180180

181181
As well as setting up the services using PHP as above you can also use
182-
configuration files. This allows you to use XML or Yaml to write the definitions
182+
configuration files. This allows you to use XML or YAML to write the definitions
183183
for the services rather than using PHP to define the services as in the above
184184
examples. In anything but the smallest applications it make sense to organize
185185
the service definitions by moving them into one or more configuration files.

components/dependency_injection/parameters.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ key, and define the type as ``constant``.
275275
276276
.. note::
277277

278-
This does not work for Yaml configuration. If you're using Yaml, you can
278+
This does not work for YAML configuration. If you're using YAML, you can
279279
import an XML file to take advantage of this functionality:
280280

281281
.. configuration-block::
@@ -316,7 +316,7 @@ To disable this behavior, use the ``string`` type:
316316
317317
.. note::
318318

319-
This is not available for Yaml and PHP, because they already have built-in
319+
This is not available for YAML and PHP, because they already have built-in
320320
support for the PHP keywords.
321321

322322
Syntax for Referencing Services
@@ -327,10 +327,10 @@ each format. You can configure the behavior if the referenced service does
327327
not exist. By default, an exception is thrown when a non-existent service
328328
is referenced.
329329

330-
Yaml
330+
YAML
331331
~~~~
332332

333-
Start the string with ``@`` or ``@?`` to reference a service in Yaml.
333+
Start the string with ``@`` or ``@?`` to reference a service in YAML.
334334

335335
* ``@mailer`` references the ``mailer`` service. If the service does not
336336
exists, an exception will be thrown;
@@ -339,7 +339,7 @@ Start the string with ``@`` or ``@?`` to reference a service in Yaml.
339339

340340
.. tip::
341341

342-
Use ``@@`` to escape the ``@`` symbol in Yaml. ``@@mailer`` will be
342+
Use ``@@`` to escape the ``@`` symbol in YAML. ``@@mailer`` will be
343343
converted into the string ``"@mailer"`` instead of referencing the
344344
``mailer`` service.
345345

components/http_kernel/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ to create a ``Response``.
386386
This can be useful if you want to use a "view" layer: instead of returning
387387
a ``Response`` from the controller, you return data that represents the page.
388388
A listener to this event could then use this data to create a ``Response`` that
389-
is in the correct format (e.g HTML, json, etc).
389+
is in the correct format (e.g HTML, JSON, etc).
390390

391391
At this stage, if no listener sets a response on the event, then an exception
392392
is thrown: either the controller *or* one of the view listeners must always

components/options_resolver.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ be anything, but it must be an integer. You can configure these types by calling
257257
));
258258
}
259259

260-
Possible types are the ones associated with the ``is_*`` php functions or a
260+
Possible types are the ones associated with the ``is_*`` PHP functions or a
261261
class name. You can also pass an array of types as the value. For instance,
262262
``array('null', 'string')`` allows ``port`` to be ``null`` or a ``string``.
263263

components/routing/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ other loaders that work the same way:
265265
* :class:`Symfony\\Component\\Routing\\Loader\\PhpFileLoader`
266266

267267
If you use the :class:`Symfony\\Component\\Routing\\Loader\\PhpFileLoader` you
268-
have to provide the name of a php file which returns a :class:`Symfony\\Component\\Routing\\RouteCollection`::
268+
have to provide the name of a PHP file which returns a :class:`Symfony\\Component\\Routing\\RouteCollection`::
269269

270270
// RouteProvider.php
271271
use Symfony\Component\Routing\RouteCollection;

components/serializer.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The Serializer Component
66
========================
77

88
The Serializer Component is meant to be used to turn objects into a
9-
specific format (XML, JSON, Yaml, ...) and the other way around.
9+
specific format (XML, JSON, YAML, ...) and the other way around.
1010

1111
In order to do so, the Serializer Component follows the following
1212
simple schema.
@@ -128,7 +128,7 @@ JMSSerializer
128128
A popular third-party library, `JMS serializer`_, provides a more
129129
sophisticated albeit more complex solution. This library includes the
130130
ability to configure how your objects should be serialize/deserialized via
131-
annotations (as well as YML, XML and PHP), integration with the Doctrine ORM,
131+
annotations (as well as YAML, XML and PHP), integration with the Doctrine ORM,
132132
and handling of other complex cases (e.g. circular references).
133133

134134
.. _`JMS serializer`: https://github.com/schmittjoh/serializer

components/yaml/yaml_format.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. index::
2-
single: Yaml; Yaml Format
2+
single: Yaml; YAML Format
33

44
The YAML Format
55
===============

contributing/code/patches.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Set up your user information with your real name and a working email address:
4444
Windows users: when installing Git, the installer will ask what to do with
4545
line endings, and suggests replacing all LF with CRLF. This is the wrong
4646
setting if you wish to contribute to Symfony! Selecting the as-is method is
47-
your best choice, as git will convert your line feeds to the ones in the
47+
your best choice, as Git will convert your line feeds to the ones in the
4848
repository. If you have already installed Git, you can check the value of
4949
this setting by typing:
5050

@@ -375,7 +375,7 @@ patch. Before re-submitting the patch, rebase with ``upstream/master`` or
375375
.. note::
376376

377377
when doing a ``push --force``, always specify the branch name explicitly
378-
to avoid messing other branches in the repo (``--force`` tells git that
378+
to avoid messing other branches in the repo (``--force`` tells Git that
379379
you really want to mess with things so do it carefully).
380380

381381
Often, moderators will ask you to "squash" your commits. This means you will
@@ -397,7 +397,7 @@ type this command, an editor will popup showing a list of commits:
397397
398398
To squash all commits into the first one, remove the word "pick" before the
399399
second and the last commits, and replace it by the word "squash" or just "s".
400-
When you save, git will start rebasing, and if successful, will ask you to
400+
When you save, Git will start rebasing, and if successful, will ask you to
401401
edit the commit message, which by default is a listing of the commit messages
402402
of all the commits. When you finish, execute the push command.
403403

contributing/documentation/standards.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ Configuration examples should show all supported formats using
7272
:ref:`configuration blocks <docs-configuration-blocks>`. The supported formats
7373
(and their orders) are:
7474

75-
* **Configuration** (including services and routing): Yaml, Xml, Php
76-
* **Validation**: Yaml, Annotations, Xml, Php
77-
* **Doctrine Mapping**: Annotations, Yaml, Xml, Php
75+
* **Configuration** (including services and routing): YAML, XML, PHP
76+
* **Validation**: YAML, Annotations, XML, PHP
77+
* **Doctrine Mapping**: Annotations, YAML, XML, PHP
7878

7979
Example
8080
~~~~~~~
@@ -101,7 +101,7 @@ Example
101101
102102
.. caution::
103103

104-
In Yaml you should put a space after ``{`` and before ``}`` (e.g. ``{ _controller: ... }``),
104+
In YAML you should put a space after ``{`` and before ``}`` (e.g. ``{ _controller: ... }``),
105105
but this should not be done in Twig (e.g. ``{'hello' : 'value'}``).
106106

107107
.. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code

0 commit comments

Comments
 (0)