Skip to content

Commit 7cc0866

Browse files
committed
minor #16305 Correct spelling & grammar in 5.3 (gnito-org)
This PR was merged into the 5.3 branch. Discussion ---------- Correct spelling & grammar in 5.3 <!-- If your pull request fixes a BUG, use the oldest maintained branch that contains the bug (see https://symfony.com/releases for the list of maintained branches). If your pull request documents a NEW FEATURE, use the same Symfony branch where the feature was introduced (and `6.x` for features of unreleased versions). --> Commits ------- 534486b Correct spelling & grammar in 5.3
2 parents b189055 + 534486b commit 7cc0866

21 files changed

+39
-39
lines changed

cache.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -800,5 +800,5 @@ Then, register the ``SodiumMarshaller`` service using this key:
800800

801801
When configuring multiple keys, the first key will be used for reading and
802802
writing, and the additional key(s) will only be used for reading. Once all
803-
cache items encrypted with the old key have expired, you can remove
804-
``OLD_CACHE_DECRYPTION_KEY`` completely.
803+
cache items encrypted with the old key have expired, you can completely remove
804+
``OLD_CACHE_DECRYPTION_KEY``.

components/browser_kit.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Custom Header Handling
185185
The optional HTTP headers passed to the ``request()`` method follows the FastCGI
186186
request format (uppercase, underscores instead of dashes and prefixed with ``HTTP_``).
187187
Before saving those headers to the request, they are lower-cased, with ``HTTP_``
188-
stripped, and underscores turned to dashes.
188+
stripped, and underscores converted into dashes.
189189

190190
If you're making a request to an application that has special rules about header
191191
capitalization or punctuation, override the ``getHeaders()`` method, which must

components/http_foundation.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ can be accessed via several public properties:
8181
(``$request->headers->get('User-Agent')``).
8282

8383
Each property is a :class:`Symfony\\Component\\HttpFoundation\\ParameterBag`
84-
instance (or a sub-class of), which is a data holder class:
84+
instance (or a subclass of), which is a data holder class:
8585

8686
* ``request``: :class:`Symfony\\Component\\HttpFoundation\\ParameterBag` or
8787
:class:`Symfony\\Component\\HttpFoundation\\InputBag` if the data is
@@ -726,7 +726,7 @@ The ``JsonResponse`` class sets the ``Content-Type`` header to
726726
.. caution::
727727

728728
To avoid XSSI `JSON Hijacking`_, you should pass an associative array
729-
as the outer-most array to ``JsonResponse`` and not an indexed array so
729+
as the outermost array to ``JsonResponse`` and not an indexed array so
730730
that the final result is an object (e.g. ``{"object": "not inside an array"}``)
731731
instead of an array (e.g. ``[{"object": "inside an array"}]``). Read
732732
the `OWASP guidelines`_ for more information.

components/lock.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ as seconds) and ``isExpired()`` (which returns a boolean).
210210
Automatically Releasing The Lock
211211
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
212212

213-
Locks are automatically released when their Lock objects are destructed. This is
213+
Locks are automatically released when their Lock objects are destroyed. This is
214214
an implementation detail that will be important when sharing Locks between
215215
processes. In the example below, ``pcntl_fork()`` creates two processes and the
216216
Lock will be released automatically as soon as one process finishes::
@@ -508,7 +508,7 @@ locks::
508508
$store = new PostgreSqlStore($databaseConnectionOrDSN);
509509

510510
In opposite to the ``PdoStore``, the ``PostgreSqlStore`` does not need a table to
511-
store locks and does not expire.
511+
store locks and it does not expire.
512512

513513
.. versionadded:: 5.2
514514

components/messenger.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ middleware stack. The component comes with a set of middleware that you can use.
7777
When using the message bus with Symfony's FrameworkBundle, the following middleware
7878
are configured for you:
7979

80-
#. :class:`Symfony\\Component\\Messenger\\Middleware\\SendMessageMiddleware` (enables asynchronous processing, logs the processing of your messages if you pass a logger)
80+
#. :class:`Symfony\\Component\\Messenger\\Middleware\\SendMessageMiddleware` (enables asynchronous processing, logs the processing of your messages if you provide a logger)
8181
#. :class:`Symfony\\Component\\Messenger\\Middleware\\HandleMessageMiddleware` (calls the registered handler(s))
8282

8383
Example::

components/phpunit_bridge.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ Baseline Deprecations
295295
If your application has some deprecations that you can't fix for some reasons,
296296
you can tell Symfony to ignore them. The trick is to create a file with the
297297
allowed deprecations and define it as the "deprecation baseline". Deprecations
298-
inside that file are ignore but the rest of deprecations are still reported.
298+
inside that file are ignored but the rest of deprecations are still reported.
299299

300300
First, generate the file with the allowed deprecations (run the same command
301301
whenever you want to update the existing file):

components/runtime.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ application outside of the global state in 6 steps:
383383
that knows how to "run" the application object.
384384
#. The ``RunnerInterface::run(object $application)`` is called and it returns the
385385
exit status code as `int`.
386-
#. The PHP engine is exited with this status code.
386+
#. The PHP engine is terminated with this status code.
387387

388388
When creating a new runtime, there are two things to consider: First, what arguments
389389
will the end user use? Second, what will the user's application look like?

components/semaphore.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ class, which in turn requires another class to manage the storage::
4545
The semaphore is created by calling the
4646
:method:`Symfony\\Component\\Semaphore\\SemaphoreFactory::createSemaphore`
4747
method. Its first argument is an arbitrary string that represents the locked
48-
resource. Its second argument is the maximum number of process allowed. Then, a
48+
resource. Its second argument is the maximum number of processes allowed. Then, a
4949
call to the :method:`Symfony\\Component\\Semaphore\\SemaphoreInterface::acquire`
5050
method will try to acquire the semaphore::
5151

@@ -54,7 +54,7 @@ method will try to acquire the semaphore::
5454

5555
if ($semaphore->acquire()) {
5656
// The resource "pdf-invoice-generation" is locked.
57-
// You can compute and generate invoice safely here.
57+
// Here you can safely compute and generate the invoice.
5858

5959
$semaphore->release();
6060
}

components/string.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ However, other languages require thousands of symbols to display their contents.
3636
They need complex encoding standards such as `Unicode`_ and concepts like
3737
"character" no longer make sense. Instead, you have to deal with these terms:
3838

39-
* `Code points`_: they are the atomic unit of information. A string is a series
39+
* `Code points`_: they are the atomic units of information. A string is a series
4040
of code points. Each code point is a number whose meaning is given by the
4141
`Unicode`_ standard. For example, the English letter ``A`` is the ``U+0041``
4242
code point and the Japanese *kana* ```` is the ``U+306E`` code point.

components/uid.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ type, which converts to/from ULID objects automatically::
331331
// ...
332332
}
333333

334-
There's also a Doctrine generator to help autogenerate ULID values for the
334+
There's also a Doctrine generator to help auto-generate ULID values for the
335335
entity primary keys::
336336

337337
use Symfony\Bridge\Doctrine\IdGenerator\UlidGenerator;

components/var_dumper.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ option. Read more about this and other options in
258258
finished, press ``Esc.`` to hide the box again.
259259

260260
If you want to use your browser search input, press ``Ctrl. + F`` or
261-
``Cmd. + F`` again while having focus on VarDumper's search input.
261+
``Cmd. + F`` again while focusing on VarDumper's search input.
262262

263263
Using the VarDumper Component in your PHPUnit Test Suite
264264
--------------------------------------------------------

notifier.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The notifier component supports the following channels:
3939

4040
.. tip::
4141

42-
Use :doc:`secrets </configuration/secrets>` to securily store your
42+
Use :doc:`secrets </configuration/secrets>` to securely store your
4343
API's tokens.
4444

4545
.. _notifier-sms-channel:
@@ -422,10 +422,10 @@ Symfony provides the following recipients:
422422
:class:`Symfony\\Component\\Notifier\\Recipient\\NoRecipient`
423423
This is the default and is useful when there is no need to have
424424
information about the receiver. For example, the browser channel uses
425-
the current requests's :ref:`session flashbag <flash-messages>`;
425+
the current requests' :ref:`session flashbag <flash-messages>`;
426426

427427
:class:`Symfony\\Component\\Notifier\\Recipient\\Recipient`
428-
This can contain both email address and phonenumber of the user. This
428+
This can contain both the email address and the phone number of the user. This
429429
recipient can be used for all channels (depending on whether they are
430430
actually set).
431431

rate_limiter.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ squares).
5050

5151
Its main drawback is that resource usage is not evenly distributed in time and
5252
it can overload the server at the window edges. In the previous example,
53-
there are 6 accepted requests between 11:00 and 12:00.
53+
there were 6 accepted requests between 11:00 and 12:00.
5454

5555
This is more significant with bigger limits. For instance, with 5,000 requests
5656
per hour, a user could make the 4,999 requests in the last minute of some
@@ -80,15 +80,15 @@ the previous hour and 500 requests this hour. 15 minutes in to the current hour
8080
(25% of the window) the hit count would be calculated as: 75% * 4,000 + 500 = 3,500.
8181
At this point in time the user can only do 1,500 more requests.
8282

83-
The math shows that the closer the last window is, the more will the hit count
84-
of the last window effect the current limit. This will make sure that a user can
85-
do 5,000 requests per hour but only if they are spread out evenly.
83+
The math shows that the closer the last window is, the more the hit count
84+
of the last window will affect the current limit. This will make sure that a user can
85+
do 5,000 requests per hour but only if they are evenly spread out.
8686

8787
Token Bucket Rate Limiter
8888
~~~~~~~~~~~~~~~~~~~~~~~~~
8989

90-
This technique implements the `token bucket algorithm`_, which defines a
91-
continuously updating budget of resource usage. It roughly works like this:
90+
This technique implements the `token bucket algorithm`_, which defines
91+
continuously updating the budget of resource usage. It roughly works like this:
9292

9393
* A bucket is created with an initial set of tokens;
9494
* A new token is added to the bucket with a predefined frequency (e.g. every second);
@@ -103,7 +103,7 @@ of 1 token per 15 minutes:
103103

104104
<object data="_images/rate_limiter/token_bucket.svg" type="image/svg+xml"></object>
105105

106-
This algorithm handles more complex back-off algorithm to manage bursts.
106+
This algorithm handles more complex back-off burst management.
107107
For instance, it can allow a user to try a password 5 times and then only
108108
allow 1 every 15 minutes (unless the user waits 75 minutes and they will be
109109
allowed 5 tries again).

security/custom_authenticator.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ How to Write a Custom Authenticator
44
Symfony comes with :ref:`many authenticators <security-authenticators>` and
55
third party bundles also implement more complex cases like JWT and oAuth
66
2.0. However, sometimes you need to implement a custom authentication
7-
mechanism that doesn't exists yet or you need to customize one. In such
7+
mechanism that doesn't exist yet or you need to customize one. In such
88
cases, you must create and use your own authenticator.
99

1010
Authenticators should implement the
@@ -133,7 +133,7 @@ The authenticator can be enabled using the ``custom_authenticators`` setting:
133133
.. versionadded:: 5.2
134134

135135
Starting with Symfony 5.2, the custom authenticator is automatically
136-
registered as entry point if it implements ``AuthenticationEntryPointInterface``.
136+
registered as an entry point if it implements ``AuthenticationEntryPointInterface``.
137137

138138
Prior to 5.2, you had to configure the entry point separately using the
139139
``entry_point`` option. Read :doc:`/security/entry_point` for more
@@ -171,7 +171,7 @@ can define what happens in these cases:
171171

172172
**Caution**: Never use ``$exception->getMessage()`` for ``AuthenticationException``
173173
instances. This message might contain sensitive information that you
174-
don't want to expose publicly. Instead, use ``$exception->getMessageKey()``
174+
don't want to be publicly exposed. Instead, use ``$exception->getMessageKey()``
175175
and ``$exception->getMessageData()`` like shown in the full example
176176
above. Use :class:`Symfony\\Component\\Security\\Core\\Exception\\CustomUserMessageAuthenticationException`
177177
if you want to set custom error messages.

security/login_link.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ this interface::
219219
</form>
220220
{% endblock %}
221221

222-
In this controller, the user is submitting their e-mail address to the
222+
In this controller, the user is submitting their email address to the
223223
controller. Based on this property, the correct user is loaded and a login
224224
link is created using
225225
:method:`Symfony\\Component\\Security\\Http\\LoginLink\\LoginLinkHandlerInterface::createLoginLink`.
@@ -235,7 +235,7 @@ link is created using
235235
3) Send the Login Link to the User
236236
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
237237

238-
Now the link is created, it needs to be send to the user. Anyone with the
238+
Now the link is created, it needs to be sent to the user. Anyone with the
239239
link is able to login as this user, so you need to make sure to send it to
240240
a known device of them (e.g. using e-mail or SMS).
241241

security/passwords.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,7 @@ password should be stored:
448448
* :ref:`When using Doctrine's entity user provider <upgrade-the-password-doctrine>`
449449
* :ref:`When using a custom user provider <upgrade-the-password-custom-provider>`
450450

451-
After this, you're done and passwords are always hashed as secure as possible!
451+
After this, you're done and passwords are always hashed as securely as possible!
452452

453453
.. note::
454454

@@ -755,7 +755,7 @@ The Sodium Password Hasher
755755
~~~~~~~~~~~~~~~~~~~~~~~~~~
756756

757757
It uses the `Argon2 key derivation function`_. Argon2 support was introduced
758-
in PHP 7.2 by bundeling the `libsodium`_ extension.
758+
in PHP 7.2 by bundling the `libsodium`_ extension.
759759

760760
The hashed passwords are ``96`` characters long, but due to the hashing
761761
requirements saved in the resulting hash this may change in the future, so make

security/remember_me.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ The ``remember_me`` firewall defines the following configuration options:
135135

136136
``service`` (default value: ``null``)
137137
Defines the ID of the service used to handle the Remember Me feature. It's
138-
useful if you need to overwrite the current behavior entirely.
138+
useful if you need to overwrite the current behavior.
139139

140140
.. versionadded:: 5.1
141141

@@ -204,7 +204,7 @@ users to change their password. You can do this by leveraging a few special
204204

205205
.. tip::
206206

207-
There is also a ``IS_REMEMBERED`` attribute that grants *only* when the
207+
There is also a ``IS_REMEMBERED`` attribute that grants access *only* when the
208208
user is authenticated via the remember me mechanism.
209209

210210
.. versionadded:: 5.1

security/user_providers.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Using a Custom Query to Load the User
104104
The entity provider can only query from one *specific* field, specified by
105105
the ``property`` config key. If you want a bit more control over this - e.g. you
106106
want to find a user by ``email`` *or* ``username``, you can do that by
107-
implenting :class:`Symfony\\Bridge\\Doctrine\\Security\\User\\UserLoaderInterface`
107+
implementing :class:`Symfony\\Bridge\\Doctrine\\Security\\User\\UserLoaderInterface`
108108
in your :ref:`Doctrine repository <doctrine-queries>` (e.g. ``UserRepository``)::
109109

110110
// src/Repository/UserRepository.php

service_container/autowiring.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -611,7 +611,7 @@ you can use the ``@required`` annotation instead.
611611

612612
The ``#[Required]`` attribute was introduced in Symfony 5.2.
613613

614-
Despite property injection has some :ref:`drawbacks <property-injection>`,
614+
Despite property injection having some :ref:`drawbacks <property-injection>`,
615615
autowiring with ``#[Required]`` or ``@required`` can also be applied to public
616616
typed properties:
617617

testing.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -583,7 +583,7 @@ Logging in Users (Authentication)
583583

584584
When you want to add application tests for protected pages, you have to
585585
first "login" as a user. Reproducing the actual steps - such as
586-
submitting a login form - make a test very slow. For this reason, Symfony
586+
submitting a login form - makes a test very slow. For this reason, Symfony
587587
provides a ``loginUser()`` method to simulate logging in in your functional
588588
tests.
589589

validation/custom_constraint.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,8 @@ with the necessary ``validator.constraint_validator``. This means you can
232232
Create a Reusable Set of Constraints
233233
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
234234

235-
In case you need to apply some common set of constraints in different places
236-
consistently across your application, you can extend the :doc:`Compound constraint </reference/constraints/Compound>`.
235+
In case you need to consistently apply a common set of constraints
236+
across your application, you can extend the :doc:`Compound constraint </reference/constraints/Compound>`.
237237

238238
.. versionadded:: 5.1
239239

0 commit comments

Comments
 (0)