Skip to content

Commit 88e4779

Browse files
weaverryanweaverryan
committed
Merge branch 'fix_proper_nouns_and_some_formatting' of github.com:bicpi/symfony-docs into bicpi-fix_proper_nouns_and_some_formatting
Conflicts: components/serializer.rst cookbook/form/unit_testing.rst
2 parents dcb882f + 2834fd2 commit 88e4779

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+208
-208
lines changed

‎book/doctrine.rst

Lines changed: 3 additions & 3 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"
@@ -1564,7 +1564,7 @@ Some notable or interesting tasks include:
15641564
.. note::
15651565

15661566
To be able to load data fixtures to your database, you will need to have
1567-
the ``DoctrineFixturesBundle`` bundle installed. To learn how to do it,
1567+
the DoctrineFixturesBundle bundle installed. To learn how to do it,
15681568
read the ":doc:`/bundles/DoctrineFixturesBundle/index`" entry of the
15691569
documentation.
15701570

‎book/http_fundamentals.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ have all the request information at your fingertips::
246246
As a bonus, the ``Request`` class does a lot of work in the background that
247247
you'll never need to worry about. For example, the ``isSecure()`` method
248248
checks the *three* different values in PHP that can indicate whether or not
249-
the user is connecting via a secured connection (i.e. ``https``).
249+
the user is connecting via a secured connection (i.e. HTTPS).
250250

251251
.. sidebar:: ParameterBags and Request attributes
252252

‎book/installation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ Symfony itself - into the ``vendor/`` directory.
180180
.. tip::
181181

182182
When running ``php composer.phar install`` or ``php composer.phar update``,
183-
composer will execute post install/update commands to clear the cache
183+
Composer will execute post install/update commands to clear the cache
184184
and install assets. By default, the assets will be copied into your ``web``
185185
directory.
186186

@@ -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/internals.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ DependencyInjection component and a powerful plugin system (bundles).
6666
:doc:`Dependency Injection </book/service_container>` and
6767
:doc:`Bundles </cookbook/bundles/best_practices>`.
6868

69-
``FrameworkBundle`` Bundle
70-
~~~~~~~~~~~~~~~~~~~~~~~~~~
69+
FrameworkBundle
70+
~~~~~~~~~~~~~~~
7171

7272
The :namespace:`Symfony\\Bundle\\FrameworkBundle` bundle is the bundle that
7373
ties the main components and libraries together to make a lightweight and fast
@@ -254,7 +254,7 @@ or setup variables so that a Controller can be called after the event. Any
254254
listener can return a ``Response`` object via the ``setResponse()`` method on
255255
the event. In this case, all other listeners won't be called.
256256

257-
This event is used by ``FrameworkBundle`` to populate the ``_controller``
257+
This event is used by the FrameworkBundle to populate the ``_controller``
258258
``Request`` attribute, via the
259259
:class:`Symfony\\Bundle\\FrameworkBundle\\EventListener\\RouterListener`. RequestListener
260260
uses a :class:`Symfony\\Component\\Routing\\RouterInterface` object to match
@@ -273,7 +273,7 @@ the ``Request`` and determine the Controller name (stored in the
273273

274274
*Event Class*: :class:`Symfony\\Component\\HttpKernel\\Event\\FilterControllerEvent`
275275

276-
This event is not used by ``FrameworkBundle``, but can be an entry point used
276+
This event is not used by the FrameworkBundle, but can be an entry point used
277277
to modify the controller that should be executed::
278278

279279
use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
@@ -299,7 +299,7 @@ to modify the controller that should be executed::
299299

300300
*Event Class*: :class:`Symfony\\Component\\HttpKernel\\Event\\GetResponseForControllerResultEvent`
301301

302-
This event is not used by ``FrameworkBundle``, but it can be used to implement
302+
This event is not used by the FrameworkBundle, but it can be used to implement
303303
a view sub-system. This event is called *only* if the Controller does *not*
304304
return a ``Response`` object. The purpose of the event is to allow some other
305305
return value to be converted into a ``Response``.
@@ -342,7 +342,7 @@ The purpose of this event is to allow other systems to modify or replace the
342342
// ... modify the response object
343343
}
344344

345-
The ``FrameworkBundle`` registers several listeners:
345+
The FrameworkBundle registers several listeners:
346346

347347
* :class:`Symfony\\Component\\HttpKernel\\EventListener\\ProfilerListener`:
348348
collects data for the current request;
@@ -387,7 +387,7 @@ was already served to the client.
387387

388388
*Event Class*: :class:`Symfony\\Component\\HttpKernel\\Event\\GetResponseForExceptionEvent`
389389

390-
``FrameworkBundle`` registers an
390+
The FrameworkBundle registers an
391391
:class:`Symfony\\Component\\HttpKernel\\EventListener\\ExceptionListener` that
392392
forwards the ``Request`` to a given Controller (the value of the
393393
``exception_listener.controller`` parameter -- must be in the

‎book/page_creation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -840,7 +840,7 @@ format you prefer:
840840

841841
Each top-level entry like ``framework`` or ``twig`` defines the configuration
842842
for a particular bundle. For example, the ``framework`` key defines the configuration
843-
for the core Symfony ``FrameworkBundle`` and includes configuration for the
843+
for the core Symfony FrameworkBundle and includes configuration for the
844844
routing, templating, and other core systems.
845845

846846
For now, don't worry about the specific configuration options in each section.
@@ -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/propel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ After creating your ``schema.xml``, generate your model from it by running:
126126
$ php app/console propel:model:build
127127
128128
This generates each model class to quickly develop your application in the
129-
``Model/`` directory the ``AcmeStoreBundle`` bundle.
129+
``Model/`` directory of the ``AcmeStoreBundle`` bundle.
130130

131131
Creating the Database Tables/Schema
132132
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎book/routing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1175,7 +1175,7 @@ In an upcoming section, you'll learn how to generate URLs from inside templates.
11751175

11761176
.. tip::
11771177

1178-
If the frontend of your application uses AJAX requests, you might want
1178+
If the frontend of your application uses Ajax requests, you might want
11791179
to be able to generate URLs in JavaScript based on your routing configuration.
11801180
By using the `FOSJsRoutingBundle`_, you can do exactly that:
11811181

‎book/security.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1007,7 +1007,7 @@ authorization from inside a controller::
10071007

10081008
.. _book-security-securing-controller-annotations:
10091009

1010-
You can also choose to install and use the optional ``JMSSecurityExtraBundle``,
1010+
You can also choose to install and use the optional JMSSecurityExtraBundle,
10111011
which can secure your controller using annotations::
10121012

10131013
// ...

‎book/service_container.rst

Lines changed: 10 additions & 10 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
@@ -464,9 +464,9 @@ In other words, a service container extension configures the services for
464464
a bundle on your behalf. And as you'll see in a moment, the extension provides
465465
a sensible, high-level interface for configuring the bundle.
466466

467-
Take the ``FrameworkBundle`` - the core Symfony2 framework bundle - as an
467+
Take the FrameworkBundle - the core Symfony2 framework bundle - as an
468468
example. The presence of the following code in your application configuration
469-
invokes the service container extension inside the ``FrameworkBundle``:
469+
invokes the service container extension inside the FrameworkBundle:
470470

471471
.. configuration-block::
472472

@@ -514,21 +514,21 @@ invokes the service container extension inside the ``FrameworkBundle``:
514514
515515
When the configuration is parsed, the container looks for an extension that
516516
can handle the ``framework`` configuration directive. The extension in question,
517-
which lives in the ``FrameworkBundle``, is invoked and the service configuration
518-
for the ``FrameworkBundle`` is loaded. If you remove the ``framework`` key
517+
which lives in the FrameworkBundle, is invoked and the service configuration
518+
for the FrameworkBundle is loaded. If you remove the ``framework`` key
519519
from your application configuration file entirely, the core Symfony2 services
520520
won't be loaded. The point is that you're in control: the Symfony2 framework
521521
doesn't contain any magic or perform any actions that you don't have control
522522
over.
523523

524524
Of course you can do much more than simply "activate" the service container
525-
extension of the ``FrameworkBundle``. Each extension allows you to easily
525+
extension of the FrameworkBundle. Each extension allows you to easily
526526
customize the bundle, without worrying about how the internal services are
527527
defined.
528528

529529
In this case, the extension allows you to customize the ``error_handler``,
530530
``csrf_protection``, ``router`` configuration and much more. Internally,
531-
the ``FrameworkBundle`` uses the options specified here to define and configure
531+
the FrameworkBundle uses the options specified here to define and configure
532532
the services specific to it. The bundle takes care of creating all the necessary
533533
``parameters`` and ``services`` for the service container, while still allowing
534534
much of the configuration to be easily customized. As an added bonus, most
@@ -934,7 +934,7 @@ the framework.
934934
Be sure that the ``swiftmailer`` entry appears in your application
935935
configuration. As was mentioned in :ref:`service-container-extension-configuration`,
936936
the ``swiftmailer`` key invokes the service extension from the
937-
``SwiftmailerBundle``, which registers the ``mailer`` service.
937+
SwiftmailerBundle, which registers the ``mailer`` service.
938938

939939
.. _book-service-container-tags:
940940

@@ -975,7 +975,7 @@ to be used for a specific purpose. Take the following example:
975975
$definition->addTag('twig.extension');
976976
$container->setDefinition('foo.twig.extension', $definition);
977977
978-
The ``twig.extension`` tag is a special tag that the ``TwigBundle`` uses
978+
The ``twig.extension`` tag is a special tag that the TwigBundle uses
979979
during configuration. By giving the service this ``twig.extension`` tag,
980980
the bundle knows that the ``foo.twig.extension`` service should be registered
981981
as a Twig extension with Twig. In other words, Twig finds all services tagged

‎book/templating.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1278,10 +1278,10 @@ Overriding Core Templates
12781278
~~~~~~~~~~~~~~~~~~~~~~~~~
12791279

12801280
Since the Symfony2 framework itself is just a bundle, core templates can be
1281-
overridden in the same way. For example, the core ``TwigBundle`` contains
1281+
overridden in the same way. For example, the core TwigBundle contains
12821282
a number of different "exception" and "error" templates that can be overridden
12831283
by copying each from the ``Resources/views/Exception`` directory of the
1284-
``TwigBundle`` to, you guessed it, the
1284+
TwigBundle to, you guessed it, the
12851285
``app/Resources/TwigBundle/views/Exception`` directory.
12861286

12871287
.. index::

‎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
exist, 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: 2 additions & 2 deletions
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
@@ -482,7 +482,7 @@ as possible to the client (e.g. sending emails).
482482

483483
.. sidebar:: ``kernel.terminate`` in the Symfony Framework
484484

485-
If you use the ``SwiftmailerBundle`` with Symfony2 and use ``memory``
485+
If you use the SwiftmailerBundle with Symfony2 and use ``memory``
486486
spooling, then the :class:`Symfony\\Bundle\\SwiftmailerBundle\\EventListener\\EmailSenderListener`
487487
is activated, which actually delivers any emails that you scheduled to
488488
send during the request.

‎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;

0 commit comments

Comments
 (0)