Skip to content

Commit 3f15a51

Browse files
committed
Merge branch '4.2' into 4.3
* 4.2: Fix many typos and improve grammar
2 parents 85347ad + 8dd96b9 commit 3f15a51

Some content is hidden

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

48 files changed

+67
-67
lines changed

_build/maintainer_guide.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ interface. Then:
9393
Merging Process
9494
~~~~~~~~~~~~~~~
9595

96-
At first it's common to make mistakes and merge things badly. Don't worry. This
96+
At first, it's common to make mistakes and merge things badly. Don't worry. This
9797
has happened to all of us and we've always been able to recover from any mistake.
9898

9999
Step 1: Select the right branch to merge

best_practices/introduction.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ that fit the philosophy of the framework as envisioned by its original creator
2525

2626
.. note::
2727

28-
**Best practice** is a noun that means *"a well defined procedure that is
28+
**Best practice** is a noun that means *"a well-defined procedure that is
2929
known to produce near-optimum results"*. And that's exactly what this
3030
guide aims to provide. Even if you don't agree with every recommendation,
3131
we believe these will help you build great applications with less complexity.

bundles/configuration.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ Providing an XML Schema
381381

382382
XML has a very useful feature called `XML schema`_. This allows you to
383383
describe all possible elements and attributes and their values in an XML Schema
384-
Definition (an xsd file). This XSD file is used by IDEs for auto completion and
384+
Definition (an XSD file). This XSD file is used by IDEs for auto completion and
385385
it is used by the Config component to validate the elements.
386386

387387
In order to use the schema, the XML configuration file must provide an

components/asset.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ simple. Hardcoding URLs can be a disadvantage because:
3030
is essential for some applications because it allows you to control how
3131
the assets are cached. The Asset component allows you to define different
3232
versioning strategies for each package;
33-
* **Moving assets location** is cumbersome and error-prone: it requires you to
33+
* **Moving assets' location** is cumbersome and error-prone: it requires you to
3434
carefully update the URLs of all assets included in all templates. The Asset
3535
component allows to move assets effortlessly just by changing the base path
3636
value associated with the package of assets;
@@ -302,7 +302,7 @@ constructor::
302302
// result: http://static2.example.com/images/icon.png?v1
303303

304304
For each asset, one of the URLs will be randomly used. But, the selection
305-
is deterministic, meaning that each asset will be always served by the same
305+
is deterministic, meaning that each asset will always be served by the same
306306
domain. This behavior simplifies the management of HTTP cache.
307307

308308
Request Context Aware Assets

components/cache.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Now you can create, retrieve, update and delete items using this cache pool::
182182
// retrieve the cache item
183183
$productsCount = $cache->getItem('stats.products_count');
184184
if (!$productsCount->isHit()) {
185-
// ... item does not exists in the cache
185+
// ... item does not exist in the cache
186186
}
187187
// retrieve the value stored by the item
188188
$total = $productsCount->get();

components/cache/adapters/memcached_adapter.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ Available Options
241241

242242
``server_failure_limit`` (type: ``int``, default: ``0``)
243243
Specifies the failure limit for server connection attempts before marking
244-
the server as "dead". The server will remaining in the server pool unless
244+
the server as "dead". The server will remain in the server pool unless
245245
``auto_eject_hosts`` is enabled.
246246

247247
Valid option values include *any positive integer*.

components/cache/cache_invalidation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ change in the state of your model. The most basic kind of invalidation is direct
1010
items deletion. But when the state of a primary resource has spread across
1111
several cached items, keeping them in sync can be difficult.
1212

13-
The Symfony Cache component provides two mechanisms to help solving this problem:
13+
The Symfony Cache component provides two mechanisms to help solve this problem:
1414

1515
* :ref:`Tags-based invalidation <cache-component-tags>` for managing data dependencies;
1616
* :ref:`Expiration based invalidation <cache-component-expiration>` for time-related dependencies.

components/cache/cache_items.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ corresponding *getter* methods::
6767
Cache Item Expiration
6868
~~~~~~~~~~~~~~~~~~~~~
6969

70-
By default cache items are stored permanently. In practice, this "permanent
70+
By default, cache items are stored permanently. In practice, this "permanent
7171
storage" can vary greatly depending on the type of cache being used, as
7272
explained in the :doc:`/components/cache/cache_pools` article.
7373

components/cache/cache_pools.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Cache Pools and Supported Adapters
1616

1717
Cache Pools are the logical repositories of cache items. They perform all the
1818
common operations on items, such as saving them or looking for them. Cache pools
19-
are independent from the actual cache implementation. Therefore, applications
19+
are independent of the actual cache implementation. Therefore, applications
2020
can keep using the same cache pool even if the underlying cache mechanism
2121
changes from a file system based cache to a Redis or database based cache.
2222

components/config/definition.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,7 @@ For all nodes:
531531
Appending Sections
532532
------------------
533533

534-
If you have a complex configuration to validate then the tree can grow to
534+
If you have a complex configuration to validate, then the tree can grow to
535535
be large and you may want to split it up into sections. You can do this
536536
by making a section a separate node and then appending it into the main
537537
tree with ``append()``::
@@ -702,8 +702,8 @@ and sometimes only:
702702
703703
<connection>default</connection>
704704
705-
By default ``connection`` would be an array in the first case and a string
706-
in the second making it difficult to validate. You can ensure it is always
705+
By default, ``connection`` would be an array in the first case and a string
706+
in the second, making it difficult to validate. You can ensure it is always
707707
an array with ``fixXmlConfig()``.
708708

709709
You can further control the normalization process if you need to. For example,

components/console/helpers/table.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ You can optionally display titles at the top and the bottom of the table::
8888
| 80-902734-1-6 | And Then There Were None | Agatha Christie |
8989
+---------------+--------- Page 1/2 -------+------------------+
9090
91-
By default the width of the columns is calculated automatically based on their
91+
By default, the width of the columns is calculated automatically based on their
9292
contents. Use the :method:`Symfony\\Component\\Console\\Helper\\Table::setColumnWidths`
9393
method to set the column widths explicitly::
9494

components/dependency_injection/compilation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ serves at dumping the compiled container::
469469
}
470470

471471
``ProjectServiceContainer`` is the default name given to the dumped container
472-
class. However you can change this with the ``class`` option when you
472+
class. However, you can change this with the ``class`` option when you
473473
dump it::
474474

475475
// ...

components/event_dispatcher.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Introduction
1313
------------
1414

1515
Object-oriented code has gone a long way to ensuring code extensibility.
16-
By creating classes that have well defined responsibilities, your code becomes
16+
By creating classes that have well-defined responsibilities, your code becomes
1717
more flexible and a developer can extend them with subclasses to modify
1818
their behaviors. But if they want to share the changes with other developers
1919
who have also made their own subclasses, code inheritance is no longer the

components/http_foundation/session_php_bridge.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ As stated elsewhere, Symfony Sessions are designed to replace the use of
1212
PHP's native ``session_*()`` functions and use of the ``$_SESSION``
1313
superglobal. Additionally, it is mandatory for Symfony to start the session.
1414

15-
However when there really are circumstances where this is not possible, you
15+
However, when there really are circumstances where this is not possible, you
1616
can use a special storage bridge
1717
:class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\PhpBridgeSessionStorage`
1818
which is designed to allow Symfony to work with a session started outside of
@@ -46,4 +46,3 @@ of your application to Symfony sessions.
4646
cannot access arbitrary keys in ``$_SESSION`` that may be set by the legacy
4747
application, although all the ``$_SESSION`` contents will be saved when
4848
the session is saved.
49-

components/serializer.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -735,15 +735,15 @@ There are several types of normalizers available:
735735
:class:`Symfony\\Component\\Serializer\\Normalizer\\DateTimeNormalizer`
736736
This normalizer converts :phpclass:`DateTimeInterface` objects (e.g.
737737
:phpclass:`DateTime` and :phpclass:`DateTimeImmutable`) into strings.
738-
By default it uses the RFC3339_ format.
738+
By default, it uses the RFC3339_ format.
739739

740740
:class:`Symfony\\Component\\Serializer\\Normalizer\\DataUriNormalizer`
741741
This normalizer converts :phpclass:`SplFileInfo` objects into a data URI
742742
string (``data:...``) such that files can be embedded into serialized data.
743743

744744
:class:`Symfony\\Component\\Serializer\\Normalizer\\DateIntervalNormalizer`
745745
This normalizer converts :phpclass:`DateInterval` objects into strings.
746-
By default it uses the ``P%yY%mM%dDT%hH%iM%sS`` format.
746+
By default, it uses the ``P%yY%mM%dDT%hH%iM%sS`` format.
747747

748748
:class:`Symfony\\Component\\Serializer\\Normalizer\\ConstraintViolationListNormalizer`
749749
This normalizer converts objects that implement

components/translation/usage.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ for the individual translation, and can be the message in the main locale (e.g.
3131
*"Symfony is great"*) of your application or a unique identifier (e.g.
3232
``symfony.great`` - see the sidebar below).
3333

34-
Translation files can be created in several different formats, XLIFF being the
34+
Translation files can be created in several formats, XLIFF being the
3535
recommended format. These files are parsed by one of the loader classes.
3636

3737
.. configuration-block::

components/var_dumper/advanced.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ similar to PHP's short array notation::
259259
// ]
260260

261261
If you would like to use both options, then you can combine them by
262-
using a the logical OR operator ``|``::
262+
using the logical OR operator ``|``::
263263

264264
use Symfony\Component\VarDumper\Dumper\AbstractDumper;
265265
use Symfony\Component\VarDumper\Dumper\CliDumper;

components/yaml.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ representation to the inline one::
188188
Indentation
189189
...........
190190

191-
By default the YAML component will use 4 spaces for indentation. This can be
191+
By default, the YAML component will use 4 spaces for indentation. This can be
192192
changed using the third argument as follows::
193193

194194
// uses 8 spaces for indentation
@@ -277,7 +277,7 @@ representation of the object as a map.
277277
Handling Invalid Types
278278
~~~~~~~~~~~~~~~~~~~~~~
279279

280-
By default the parser will encode invalid types as ``null``. You can make the
280+
By default, the parser will encode invalid types as ``null``. You can make the
281281
parser throw exceptions by using the ``PARSE_EXCEPTION_ON_INVALID_TYPE``
282282
flag::
283283

@@ -294,7 +294,7 @@ Similarly you can use ``DUMP_EXCEPTION_ON_INVALID_TYPE`` when dumping::
294294
Date Handling
295295
~~~~~~~~~~~~~
296296

297-
By default the YAML parser will convert unquoted strings which look like a
297+
By default, the YAML parser will convert unquoted strings which look like a
298298
date or a date-time into a Unix timestamp; for example ``2016-05-27`` or
299299
``2016-05-27T02:59:43.1Z`` (ISO-8601_)::
300300

@@ -309,7 +309,7 @@ flag::
309309
Dumping Multi-line Literal Blocks
310310
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
311311

312-
In YAML multiple lines can be represented as literal blocks, by default the
312+
In YAML, multiple lines can be represented as literal blocks. By default, the
313313
dumper will encode multiple lines as an inline string::
314314

315315
$string = ["string" => "Multiple\nLine\nString"];

configuration/env_var_processors.rst

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. index::
2+
23
single: Environment Variable Processors; env vars
34

45
.. _env-var-processors:

configuration/using_parameters_in_dic.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -143,5 +143,5 @@ And set it in the constructor of ``Configuration`` via the ``Extension`` class::
143143
.. tip::
144144

145145
There are some instances of ``%kernel.debug%`` usage within a
146-
``Configurator`` class for example in TwigBundle. However this is because
146+
``Configurator`` class for example in TwigBundle. However, this is because
147147
the default parameter value is set by the Extension class.

contributing/code/pull_requests.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ As long as you have items in the todo-list, please prefix the pull request
361361
title with "[WIP]". If you do not yet want to trigger the automated tests,
362362
you can also set the PR to `draft status`_.
363363

364-
In the pull request description, give as much details as possible about your
364+
In the pull request description, give as much detail as possible about your
365365
changes (don't hesitate to give code examples to illustrate your points). If
366366
your pull request is about adding a new feature or modifying an existing one,
367367
explain the rationale for the changes. The pull request description helps the

contributing/code/standards.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ Naming Conventions
209209

210210
* Prefix all abstract classes with ``Abstract`` except PHPUnit ``*TestCase``.
211211
Please note some early Symfony classes do not follow this convention and
212-
have not been renamed for backward compatibility reasons. However all new
212+
have not been renamed for backward compatibility reasons. However, all new
213213
abstract classes must follow this naming convention;
214214

215215
* Suffix interfaces with ``Interface``;

contributing/code_of_conduct/reporting_guidelines.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ let them know what action (if any) we'll be taking. We'll take into account feed
6969
from the reporter on the appropriateness of our response, but our response will be
7070
determined by what will be best for community safety.
7171

72-
The CARE team keeps a private record of all incidents. By default all reports
72+
The CARE team keeps a private record of all incidents. By default, all reports
7373
are shared with the entire CARE team unless the reporter specifically asks
7474
to exclude specific CARE team members, in which case these CARE team
7575
members will not be included in any communication on the incidents as well as records

contributing/documentation/standards.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Files and Directories
135135
* When referencing file extensions explicitly, you should include a leading dot
136136
for every extension (e.g. "XML files use the ``.xml`` extension").
137137
* When you list a Symfony file/directory hierarchy, use ``your-project/`` as the
138-
top level directory. E.g.
138+
top-level directory. E.g.
139139

140140
.. code-block:: text
141141

create_framework/front_controller.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ We have the first version of our framework::
220220

221221
$response->send();
222222

223-
Adding a new page is a two step process: add an entry in the map and create a
223+
Adding a new page is a two-step process: add an entry in the map and create a
224224
PHP template in ``src/pages/``. From a template, get the Request data via the
225225
``$request`` variable and tweak the Response headers via the ``$response``
226226
variable.

create_framework/http_kernel_controller_resolver.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Update the route definition accordingly::
2828
]));
2929

3030
The move is pretty straightforward and makes a lot of sense as soon as you
31-
create more pages but you might have noticed a non-desirable side-effect...
31+
create more pages but you might have noticed a non-desirable side effect...
3232
The ``LeapYearController`` class is *always* instantiated, even if the
3333
requested URL does not match the ``leap_year`` route. This is bad for one main
3434
reason: performance wise, all controllers for all routes must now be

create_framework/separation_of_concerns.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ To sum up, here is the new file layout:
163163
└── front.php
164164
165165
That's it! Our application has now four different layers and each of them has
166-
a well defined goal:
166+
a well-defined goal:
167167

168168
* ``web/front.php``: The front controller; the only exposed PHP code that
169169
makes the interface with the client (it gets the Request and sends the

form/data_transformers.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ Now, you can use your ``TaskType``::
346346
// ...
347347

348348
Cool, you're done! Your user will be able to enter an issue number into the
349-
text field and it will be transformed back into an Issue object. This means
349+
text field, which will be transformed back into an Issue object. This means
350350
that, after a successful submission, the Form component will pass a real
351351
``Issue`` object to ``Task::setIssue()`` instead of the issue number.
352352

form/dynamic_form_modification.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ Dynamic Generation for Submitted Forms
362362
Another case that can appear is that you want to customize the form specific to
363363
the data that was submitted by the user. For example, imagine you have a registration
364364
form for sports gatherings. Some events will allow you to specify your preferred
365-
position on the field. This would be a ``choice`` field for example. However the
365+
position on the field. This would be a ``choice`` field for example. However, the
366366
possible choices will depend on each sport. Football will have attack, defense,
367367
goalkeeper etc... Baseball will have a pitcher but will not have a goalkeeper. You
368368
will need the correct options in order for validation to pass.

form/embedded.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Next, add a new ``category`` property to the ``Task`` class::
6060
.. tip::
6161

6262
The ``Valid`` Constraint has been added to the property ``category``. This
63-
cascades the validation to the corresponding entity. If you omit this constraint
63+
cascades the validation to the corresponding entity. If you omit this constraint,
6464
the child entity would not be validated.
6565

6666
Now that your application has been updated to reflect the new requirements,

frontend/encore/installation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ is the main config file for both Webpack and Webpack Encore:
7171
* (including one that's included on every page - e.g. "app")
7272
*
7373
* Each entry will result in one JavaScript file (e.g. app.js)
74-
* and one CSS file (e.g. app.css) if you JavaScript imports CSS.
74+
* and one CSS file (e.g. app.css) if your JavaScript imports CSS.
7575
*/
7676
.addEntry('app', './assets/js/app.js')
7777
//.addEntry('page1', './assets/js/page1.js')

http_cache.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ two things:
322322
and mutating your application.
323323

324324
* POST requests are generally considered uncacheable, but `they can be cached`_
325-
when they include explicit freshness information. However POST caching is not
325+
when they include explicit freshness information. However, POST caching is not
326326
widely implemented, so you should avoid it if possible.
327327

328328
* You should *never* change the state of your application (e.g. update a blog post)

logging/channels_handlers.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ from the ``security`` channel:
9696
9797
.. caution::
9898

99-
The ``channels`` configuration only works for top level handlers. Handlers
99+
The ``channels`` configuration only works for top-level handlers. Handlers
100100
that are nested inside a group, buffer, filter, fingers crossed or other
101101
such handler will ignore this configuration and will process every message
102102
passed to them.

reference/configuration/framework.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -1171,7 +1171,7 @@ name
11711171

11721172
**type**: ``string`` **default**: ``null``
11731173

1174-
This specifies the name of the session cookie. By default it will use the
1174+
This specifies the name of the session cookie. By default, it will use the
11751175
cookie name which is defined in the ``php.ini`` with the ``session.name``
11761176
directive.
11771177

@@ -1190,15 +1190,15 @@ cookie_path
11901190

11911191
**type**: ``string`` **default**: ``/``
11921192

1193-
This determines the path to set in the session cookie. By default it will
1193+
This determines the path to set in the session cookie. By default, it will
11941194
use ``/``.
11951195

11961196
cookie_domain
11971197
.............
11981198

11991199
**type**: ``string`` **default**: ``''``
12001200

1201-
This determines the domain to set in the session cookie. By default it's
1201+
This determines the domain to set in the session cookie. By default, it's
12021202
blank, meaning the host name of the server which generated the cookie according
12031203
to the cookie specification.
12041204

@@ -1409,7 +1409,7 @@ use_cookies
14091409
**type**: ``boolean`` **default**: ``null``
14101410

14111411
This specifies if the session ID is stored on the client side using cookies or
1412-
not. By default it will use the value defined in the ``php.ini`` with the
1412+
not. By default, it will use the value defined in the ``php.ini`` with the
14131413
``session.use_cookies`` directive.
14141414

14151415
assets

0 commit comments

Comments
 (0)