Skip to content

Commit 775afce

Browse files
committed
minor #11854 Fix many typos and improve grammar (Calinou)
This PR was merged into the 3.4 branch. Discussion ---------- Fix many typos and improve grammar Follow-up to #11645. Commits ------- 97f4eeb Fix many typos and improve grammar
2 parents c84deae + 97f4eeb commit 775afce

File tree

66 files changed

+95
-96
lines changed

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

+95
-96
lines changed

_build/maintainer_guide.rst

Lines changed: 1 addition & 1 deletion
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/controllers.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ means that controllers should hold just the thin layer of *glue-code*
66
needed to coordinate the different parts of the application.
77

88
As a rule of thumb, you should follow the 5-10-20 rule, where controllers should
9-
only define 5 variables or less, contain 10 actions or less and include 20 lines
10-
of code or less in each action. This isn't an exact science, but it should
9+
only define 5 variables or fewer, contain 10 actions or fewer and include 20 lines
10+
of code or fewer in each action. This isn't an exact science, but it should
1111
help you realize when code should be refactored out of the controller and
1212
into a service.
1313

best_practices/i18n.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Traditionally, Symfony developers have created these files in the
5454
``app/Resources/`` directory is considered the global location for the
5555
application's resources, storing translations in ``app/Resources/translations/``
5656
centralizes them *and* gives them priority over any other translation file.
57-
This let's you override translations defined in third-party bundles.
57+
This lets you override translations defined in third-party bundles.
5858

5959
Translation Keys
6060
----------------

best_practices/introduction.rst

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,7 @@ Providing an XML Schema
390390

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

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

components/asset.rst

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Now you can create, retrieve, update and delete items using this object::
7070

7171
// retrieve the cache item
7272
if (!$cache->has('stats.products_count')) {
73-
// ... item does not exists in the cache
73+
// ... item does not exist in the cache
7474
}
7575

7676
// retrieve the value stored by the item
@@ -171,7 +171,7 @@ Now you can create, retrieve, update and delete items using this cache pool::
171171
// retrieve the cache item
172172
$productsCount = $cache->getItem('stats.products_count');
173173
if (!$productsCount->isHit()) {
174-
// ... item does not exists in the cache
174+
// ... item does not exist in the cache
175175
}
176176
// retrieve the value stored by the item
177177
$total = $productsCount->get();

components/cache/adapters/memcached_adapter.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ Available Options
240240

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

246246
Valid option values include *any positive integer*.

components/cache/cache_invalidation.rst

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ corresponding *getter* methods::
5858
Cache Item Expiration
5959
~~~~~~~~~~~~~~~~~~~~~
6060

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

components/cache/cache_pools.rst

Lines changed: 1 addition & 1 deletion
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/class_loader.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The ClassLoader Component
99

1010
.. caution::
1111

12-
The ClassLoader component was deprecated in Symfony 3.3 and it will be
12+
The ClassLoader component was deprecated in Symfony 3.3 and will be
1313
removed in 4.0. As an alternative, use any of the `class loading optimizations`_
1414
provided by Composer.
1515

components/config/definition.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ For all nodes:
538538
Appending Sections
539539
------------------
540540

541-
If you have a complex configuration to validate then the tree can grow to
541+
If you have a complex configuration to validate, then the tree can grow to
542542
be large and you may want to split it up into sections. You can do this
543543
by making a section a separate node and then appending it into the main
544544
tree with ``append()``::
@@ -711,8 +711,8 @@ and sometimes only:
711711
712712
<connection>default</connection>
713713
714-
By default ``connection`` would be an array in the first case and a string
715-
in the second making it difficult to validate. You can ensure it is always
714+
By default, ``connection`` would be an array in the first case and a string
715+
in the second, making it difficult to validate. You can ensure it is always
716716
an array with ``fixXmlConfig()``.
717717

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

components/console/helpers/table.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ You can add a table separator anywhere in the output by passing an instance of
6969
| 80-902734-1-6 | And Then There Were None | Agatha Christie |
7070
+---------------+--------------------------+------------------+
7171
72-
By default the width of the columns is calculated automatically based on their
72+
By default, the width of the columns is calculated automatically based on their
7373
contents. Use the :method:`Symfony\\Component\\Console\\Helper\\Table::setColumnWidths`
7474
method to set the column widths explicitly::
7575

components/dependency_injection/compilation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ makes dumping the compiled container easy::
473473
}
474474

475475
``ProjectServiceContainer`` is the default name given to the dumped container
476-
class. However you can change this with the ``class`` option when you
476+
class. However, you can change this with the ``class`` option when you
477477
dump it::
478478

479479
// ...

components/event_dispatcher.rst

Lines changed: 1 addition & 1 deletion
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/event_dispatcher/container_aware_dispatcher.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The Container Aware Event Dispatcher
77
.. deprecated:: 3.3
88

99
The ``ContainerAwareEventDispatcher`` class has been deprecated in Symfony 3.3
10-
and it will be removed in Symfony 4.0. Use ``EventDispatcher`` with
10+
and will be removed in Symfony 4.0. Use ``EventDispatcher`` with
1111
closure-proxy injection instead.
1212

1313
Introduction

components/filesystem/lock_handler.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ LockHandler
33

44
.. deprecated:: 3.4
55

6-
The ``LockHandler`` class was deprecated in Symfony 3.4 and it will be
6+
The ``LockHandler`` class was deprecated in Symfony 3.4 and will be
77
removed in Symfony 4.0. Use :ref:`SemaphoreStore <lock-store-semaphore>`
88
or :ref:`FlockStore <lock-store-flock>` from the Lock component instead.
99

components/http_foundation/session_php_bridge.rst

Lines changed: 1 addition & 2 deletions
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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -630,7 +630,7 @@ There are several types of normalizers available:
630630
:class:`Symfony\\Component\\Serializer\\Normalizer\\DateTimeNormalizer`
631631
This normalizer converts :phpclass:`DateTimeInterface` objects (e.g.
632632
:phpclass:`DateTime` and :phpclass:`DateTimeImmutable`) into strings.
633-
By default it uses the RFC3339_ format.
633+
By default, it uses the RFC3339_ format.
634634

635635
.. versionadded:: 3.2
636636

@@ -643,7 +643,7 @@ There are several types of normalizers available:
643643

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

648648
.. versionadded:: 3.4
649649

components/translation/usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ for the individual translation, and can be the message in the main locale (e.g.
104104
*"Symfony is great"*) of your application or a unique identifier (e.g.
105105
``symfony.great`` - see the sidebar below).
106106

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

110110
.. configuration-block::
@@ -351,7 +351,7 @@ effect after removing the explicit rules:
351351
'{0} There are no apples|[20,Inf[ There are many apples|There is one apple|a_few: There are %count% apples'
352352
353353
For example, for ``1`` apple, the standard rule ``There is one apple`` will
354-
be used. For ``2-19`` apples, the second standard rule
354+
be used. For ``2-19`` apples, the second standard rule
355355
``There are %count% apples`` will be selected.
356356

357357
An :class:`Symfony\\Component\\Translation\\Interval` can represent a finite set

components/var_dumper/advanced.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,8 @@ similar to PHP's short array notation::
278278
// 0 => "test"
279279
// ]
280280

281-
If you would like to use both options, then you can just combine them by
282-
using a the logical OR operator ``|``::
281+
If you would like to use both options, then you can just combine them by
282+
using the logical OR operator ``|``::
283283

284284
use Symfony\Component\VarDumper\Dumper\AbstractDumper;
285285
use Symfony\Component\VarDumper\Dumper\CliDumper;

components/yaml.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ representation to the inline one::
192192
Indentation
193193
...........
194194

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

198198
// uses 8 spaces for indentation
@@ -290,7 +290,7 @@ representation of the object as a map.
290290
Handling Invalid Types
291291
~~~~~~~~~~~~~~~~~~~~~~
292292

293-
By default the parser will encode invalid types as ``null``. You can make the
293+
By default, the parser will encode invalid types as ``null``. You can make the
294294
parser throw exceptions by using the ``PARSE_EXCEPTION_ON_INVALID_TYPE``
295295
flag::
296296

@@ -307,7 +307,7 @@ Similarly you can use ``DUMP_EXCEPTION_ON_INVALID_TYPE`` when dumping::
307307
Date Handling
308308
~~~~~~~~~~~~~
309309

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

@@ -322,7 +322,7 @@ flag::
322322
Dumping Multi-line Literal Blocks
323323
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
324324

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

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

configuration/external_parameters.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ of the following:
125125
.. deprecated:: 3.3
126126

127127
The support of the special ``SYMFONY__`` environment variables was
128-
deprecated in Symfony 3.3 and it will be removed in 4.0. Instead of
128+
deprecated in Symfony 3.3 and will be removed in 4.0. Instead of
129129
using those variables, define regular environment variables and get
130130
their values using the ``%env(...)%`` syntax in your config files.
131131

configuration/using_parameters_in_dic.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ And set it in the constructor of ``Configuration`` via the ``Extension`` class::
144144
.. sidebar:: Setting the Default in the Extension
145145

146146
There are some instances of ``%kernel.debug%`` usage within a ``Configurator``
147-
class in TwigBundle and AsseticBundle. However this is because the default
147+
class in TwigBundle and AsseticBundle. However, this is because the default
148148
parameter value is set by the Extension class. For example in AsseticBundle,
149149
you can find::
150150

console/commands_as_services.rst

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

1111
Symfony also looks in the ``Command/`` directory of each bundle for commands
1212
non registered as a service and automatically registers those classes as
13-
commands. However this auto-registration was deprecated in Symfony 3.4. In
13+
commands. However, this auto-registration was deprecated in Symfony 3.4. In
1414
Symfony 4.0, commands won't be auto-registered anymore.
1515

1616
.. note::

contributing/code/pull_requests.rst

Lines changed: 1 addition & 1 deletion
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/reproducer.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ a PHP script, it's better to reproduce the bug by forking the Symfony Standard
3737
edition. To do so:
3838

3939
#. Go to https://github.com/symfony/symfony-standard and click on the **Fork**
40-
button to make a fork of that repository or go to your already forked copy.
40+
button to make a fork of that repository or go to your already-forked copy.
4141
#. Clone the forked repository into your computer:
4242
``git clone git://github.com/YOUR-GITHUB-USERNAME/symfony-standard.git``
4343
#. Browse the project and create a new branch (e.g. ``issue_23567``,

contributing/code/standards.rst

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Files and Directories
137137
* When referencing file extensions explicitly, you should include a leading dot
138138
for every extension (e.g. "XML files use the ``.xml`` extension").
139139
* When you list a Symfony file/directory hierarchy, use ``your-project/`` as the
140-
top level directory. E.g.
140+
top-level directory. E.g.
141141

142142
.. code-block:: text
143143

create_framework/front_controller.rst

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

Lines changed: 1 addition & 1 deletion
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

deployment/azure-website.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Enabling the PHP intl Extension
156156
no longer necessary.** You can check if the ``intl`` extension is enabled in the
157157
:phpfunction:`phpinfo` page.
158158

159-
However if the ``intl`` extension is not enabled you can follow these steps.
159+
However, if the ``intl`` extension is not enabled you can follow these steps.
160160

161161
This is the tricky part of the guide! To enable the ``intl`` extension, there is
162162
no need to upload any DLL files as the ``php_intl.dll`` file already exists on

0 commit comments

Comments
 (0)