Skip to content

Commit cdb1c3c

Browse files
committed
minor #11568 Removed more belittling words and expressions (javiereguiluz)
This PR was squashed before being merged into the 3.4 branch (closes #11568). Discussion ---------- Removed more belittling words and expressions Commits ------- cc9d8ec Removed more belittling words and expressions
2 parents c2247ed + cc9d8ec commit cdb1c3c

File tree

83 files changed

+186
-194
lines changed

Some content is hidden

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

83 files changed

+186
-194
lines changed

_build/maintainer_guide.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@ Step 2: Merge the pull request
120120
Never use GitHub's web interface (or desktop clients) to merge PRs or to solve
121121
merge conflicts. Always use the ``gh`` tool for anything related to merges.
122122

123-
We require 2 approval votes from team members before merging a PR, except if
124-
it's a typo, a small change or an obvious error.
123+
We require two approval votes from team members before merging a PR, except if
124+
it's a typo, a small change or clearly an error.
125125

126126
If a PR contains lots of commits, there's no need to ask the contributor to
127127
squash them. The ``gh`` tool does that automatically. The only exceptions are

best_practices/business-logic.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,8 @@ distributed among developers, with a slight preference towards YAML.
148148
Both formats have the same performance, so this is ultimately a matter of
149149
personal taste.
150150

151-
We recommend YAML because it's friendly to newcomers and concise. You can
152-
of course use whatever format you like.
151+
We recommend YAML because it's friendly to newcomers and concise, but you can
152+
use whatever format you like.
153153

154154
Service: No Class Parameter
155155
---------------------------
@@ -218,8 +218,7 @@ The three entities defined by our sample blog application are a good example:
218218
219219
.. tip::
220220

221-
If you're more advanced, you can of course store them under your own
222-
namespace in ``src/``.
221+
If you're more advanced, you can store them under your own namespace in ``src/``.
223222

224223
Doctrine Mapping Information
225224
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

best_practices/configuration.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,8 @@ Constants can be used for example in your Twig templates thanks to the
132132
Displaying the {{ constant('NUMBER_OF_ITEMS', post) }} most recent results.
133133
</p>
134134

135-
And Doctrine entities and repositories can now easily access these values,
136-
whereas they cannot access the container parameters::
135+
And Doctrine entities and repositories can access these values too, whereas they
136+
cannot access the container parameters::
137137

138138
namespace AppBundle\Repository;
139139

@@ -149,7 +149,7 @@ whereas they cannot access the container parameters::
149149
}
150150

151151
The only notable disadvantage of using constants for this kind of configuration
152-
values is that you cannot redefine them easily in your tests.
152+
values is that it's complicated to redefine their values in your tests.
153153

154154
Parameter Naming
155155
----------------

best_practices/controllers.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@ The ``@Template`` annotation is useful, but also involves some magic. We
8080
don't think its benefit is worth the magic, and so recommend against using
8181
it.
8282

83-
Most of the time, ``@Template`` is used without any parameters, which makes
84-
it more difficult to know which template is being rendered. It also makes
85-
it less obvious to beginners that a controller should always return a Response
86-
object (unless you're using a view layer).
83+
Most of the time, ``@Template`` is used without any parameters, which makes it
84+
more difficult to know which template is being rendered. It also hides the fact
85+
that a controller should always return a Response object (unless you're using a
86+
view layer).
8787

8888
What does the Controller look like
8989
----------------------------------

best_practices/introduction.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,10 @@ of these best practices. But by following these, you'll be able to develop
4747
applications faster, with less complexity and with the same or even higher
4848
quality. It's also a moving target that will continue to improve.
4949

50-
Keep in mind that these are **optional recommendations** that you and your
51-
team may or may not follow to develop Symfony applications. If you want to
52-
continue using your own best practices and methodologies, you can of course
53-
do it. Symfony is flexible enough to adapt to your needs. That will never
54-
change.
50+
Keep in mind that these are **optional recommendations** that you and your team
51+
may or may not follow to develop Symfony applications. If you want to continue
52+
using your own best practices and methodologies, you can do it. Symfony is
53+
flexible enough to adapt to your needs. That will never change.
5554

5655
Who this Book Is for (Hint: It's not a Tutorial)
5756
------------------------------------------------

best_practices/security.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ primarily under the ``firewalls`` key.
1919
API only), we recommend having only *one* firewall entry with the ``anonymous``
2020
key enabled.
2121

22-
Most applications only have one authentication system and one set of users.
23-
For this reason, you only need *one* firewall entry. There are exceptions
24-
of course, especially if you have separated web and API sections on your
25-
site. But the point is to keep things simple.
22+
Most applications only have one authentication system and one set of users. For
23+
this reason, you only need *one* firewall entry. If you have separated web and
24+
API sections on your site, you will need more firewall entries. But the point is
25+
to keep things simple.
2626

2727
Additionally, you should use the ``anonymous`` key under your firewall. If
2828
you need to require users to be logged in for different sections of your

best_practices/tests.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ The built-in functional testing client is great, but it can't be used to
104104
test any JavaScript behavior on your pages. If you need to test this, consider
105105
using the `Mink`_ library from within PHPUnit.
106106

107-
Of course, if you have a heavy JavaScript frontend, you should consider using
108-
pure JavaScript-based testing tools.
107+
If you have a heavy JavaScript frontend, you should consider using pure
108+
JavaScript-based testing tools.
109109

110110
Learn More about Functional Tests
111111
---------------------------------

components/console/single_command_tool.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The method :method:`Symfony\\Component\\Console\\Application::setDefaultCommand`
3333
accepts a boolean as second parameter. If true, the command ``echo`` will then
3434
always be used, without having to pass its name.
3535

36-
Of course, you can still register a command as usual::
36+
You can still register a command as usual::
3737

3838
#!/usr/bin/env php
3939
<?php

components/dom_crawler.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The :class:`Symfony\\Component\\DomCrawler\\Crawler` class provides methods
3434
to query and manipulate HTML and XML documents.
3535

3636
An instance of the Crawler represents a set of :phpclass:`DOMElement` objects,
37-
which are basically nodes that you can traverse easily::
37+
which are nodes that can be traversed as follows::
3838

3939
use Symfony\Component\DomCrawler\Crawler;
4040

components/expression_language/extending.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ or by using the second argument of the constructor::
131131
{
132132
public function __construct(ParserCacheInterface $parser = null, array $providers = [])
133133
{
134-
// prepends the default provider to let users override it easily
134+
// prepends the default provider to let users override it
135135
array_unshift($providers, new StringExpressionLanguageProvider());
136136

137137
parent::__construct($parser, $providers);

components/form.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The Form Component
66
==================
77

8-
The Form component allows you to easily create, process and reuse forms.
8+
The Form component allows you to create, process and reuse forms.
99

1010
The Form component is a tool to help you solve the problem of allowing end-users
1111
to interact with the data and modify the data in your application. And though
@@ -162,10 +162,10 @@ You can disable CSRF protection per form using the ``csrf_protection`` option::
162162
Twig Templating
163163
~~~~~~~~~~~~~~~
164164

165-
If you're using the Form component to process HTML forms, you'll need a way
166-
to easily render your form as HTML form fields (complete with field values,
167-
errors, and labels). If you use `Twig`_ as your template engine, the Form
168-
component offers a rich integration.
165+
If you're using the Form component to process HTML forms, you'll need a way to
166+
render your form as HTML form fields (complete with field values, errors, and
167+
labels). If you use `Twig`_ as your template engine, the Form component offers a
168+
rich integration.
169169

170170
To use the integration, you'll need the twig bridge, which provides integration
171171
between Twig and several Symfony components:

components/http_foundation/session_configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ handlers by providing six callback functions which PHP calls internally at
6969
various points in the session workflow.
7070

7171
The Symfony HttpFoundation component provides some by default and these can
72-
easily serve as examples if you wish to write your own.
72+
serve as examples if you wish to write your own.
7373

7474
* :class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\Handler\\PdoSessionHandler`
7575
* :class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\Handler\\MemcacheSessionHandler`

components/http_foundation/session_testing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Testing with Sessions
66
=====================
77

88
Symfony is designed from the ground up with code-testability in mind. In order
9-
to make your code which utilizes session easily testable we provide two separate
10-
mock storage mechanisms for both unit testing and functional testing.
9+
to make your code which utilizes session testable we provide two separate mock
10+
storage mechanisms for both unit testing and functional testing.
1111

1212
Testing code using real sessions is tricky because PHP's workflow state is global
1313
and it is not possible to have multiple concurrent sessions in the same PHP

components/http_kernel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This is a simplified overview of the request workflow in Symfony applications:
4545
#. The **browser** displays the **resource** to the **user**.
4646

4747
Typically, some sort of framework or system is built to handle all the repetitive
48-
tasks (e.g. routing, security, etc) so that a developer can easily build
48+
tasks (e.g. routing, security, etc) so that a developer can build
4949
each *page* of the application. Exactly *how* these systems are built varies
5050
greatly. The HttpKernel component provides an interface that formalizes
5151
the process of starting with a request and creating the appropriate response.

components/options_resolver.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -690,7 +690,7 @@ method ``clearOptionsConfig()`` and call it periodically::
690690
// ...
691691
}
692692

693-
That's it! You now have all the tools and knowledge needed to easily process
693+
That's it! You now have all the tools and knowledge needed to process
694694
options in your code.
695695

696696
.. _Packagist: https://packagist.org/packages/symfony/options-resolver

components/security/authentication.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ authentication providers, each supporting a different type of token.
9090

9191
.. note::
9292

93-
You may of course write your own authentication manager, it only has
93+
You may write your own authentication manager, it only has
9494
to implement :class:`Symfony\\Component\\Security\\Core\\Authentication\\AuthenticationManagerInterface`.
9595

9696
.. _authentication_providers:

components/security/authorization.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,8 @@ role::
159159

160160
.. note::
161161

162-
When you make your own voter, you may of course use its constructor
163-
to inject any dependencies it needs to come to a decision.
162+
When you make your own voter, you can use its constructor to inject any
163+
dependencies it needs to come to a decision.
164164

165165
Roles
166166
-----

configuration/environments.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ As you can see, when Symfony is loaded, it uses the given environment to
5151
determine which configuration file to load. This accomplishes the goal of
5252
multiple environments in an elegant, powerful and transparent way.
5353

54-
Of course, in reality, each environment differs only somewhat from others.
54+
However, in practice each environment differs only somewhat from others.
5555
Generally, all environments will share a large base of common configuration.
5656
Opening the ``config_dev.yml`` configuration file, you can see how this is
57-
accomplished easily and transparently:
57+
accomplished:
5858

5959
.. configuration-block::
6060

@@ -283,7 +283,7 @@ Creating a new Environment
283283
--------------------------
284284

285285
By default, a Symfony application has three environments that handle most
286-
cases. Of course, since an environment is nothing more than a string that
286+
cases. However, since an environment is nothing more than a string that
287287
corresponds to a set of configuration, creating a new environment is quite
288288
easy.
289289

@@ -420,7 +420,7 @@ includes the following:
420420

421421
.. note::
422422

423-
You can easily change the directory location and name. For more information
423+
You can change the directory location and name. For more information
424424
read the article :doc:`/configuration/override_dir_structure`.
425425

426426
Going further

configuration/front_controllers_and_kernel.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ to decide which bundles to create. The logic for that is in ``registerBundles()`
111111
a method meant to be extended by you when you start adding bundles to your
112112
application.
113113

114-
You are, of course, free to create your own, alternative or additional
115-
``AppKernel`` variants. All you need is to adapt your (or add a new) front
116-
controller to make use of the new kernel.
114+
You are free to create your own, alternative or additional ``AppKernel``
115+
variants. All you need is to adapt your (or add a new) front controller to make
116+
use of the new kernel.
117117

118118
.. note::
119119

@@ -154,9 +154,9 @@ used in the :method:`Symfony\\Component\\HttpKernel\\KernelInterface::registerCo
154154
method to decide which configuration files to load.
155155

156156
The Symfony Standard Edition's `AppKernel`_ class implements this method by
157-
loading the ``app/config/config_*environment*.yml`` file. You are, of course,
158-
free to implement this method differently if you need a more sophisticated
159-
way of loading your configuration.
157+
loading the ``app/config/config_*environment*.yml`` file. You are free to
158+
implement this method differently if you need a more sophisticated way of
159+
loading your configuration.
160160

161161
.. _front controller: https://en.wikipedia.org/wiki/Front_Controller_pattern
162162
.. _Symfony Standard Edition: https://github.com/symfony/symfony-standard

contributing/code/bc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ method signature.
2222

2323
Also, not every BC break has the same impact on application code. While some BC
2424
breaks require you to make significant changes to your classes or your
25-
architecture, others are fixed as easily as changing the name of a method.
25+
architecture, others can be fixed changing the name of a single method.
2626

2727
That's why we created this page for you. The section "Using Symfony Code" will
2828
tell you how you can ensure that your application won't break completely when

contributing/code/git.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Pull Requests
1010
Whenever a pull request is merged, all the information contained in the pull
1111
request (including comments) is saved in the repository.
1212

13-
You can easily spot pull request merges as the commit message always follows
14-
this pattern:
13+
You can spot pull request merges as the commit message always follows this
14+
pattern:
1515

1616
.. code-block:: text
1717

contributing/code/reproducer.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ Creating a Bug Reproducer
22
=========================
33

44
The main Symfony code repository receives thousands of issues reports per year.
5-
Some of those issues are so obvious or easy to understand, that Symfony Core
6-
developers can fix them without any other information. However, other issues are
7-
much harder to understand because developers can't easily reproduce them in their
8-
computers. That's when we'll ask you to create a "bug reproducer", which is the
9-
minimum amount of code needed to make the bug appear when executed.
5+
Some of those issues are easy to understand and the Symfony Core developers can
6+
fix them without any other information. However, other issues are much harder to
7+
understand because developers can't reproduce them in their computers. That's
8+
when we'll ask you to create a "bug reproducer", which is the minimum amount of
9+
code needed to make the bug appear when executed.
1010

1111
Reproducing Simple Bugs
1212
-----------------------

contributing/community/reviews.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ On the `Symfony issue tracker`_, you can find many items in a `Needs Review`_
2424
status:
2525

2626
* **Bug Reports**: Bug reports need to be checked for completeness.
27-
Is any important information missing? Can the bug be *easily* reproduced?
27+
Is any important information missing? Can the bug be reproduced?
2828

2929
* **Pull Requests**: Pull requests contain code that fixes a bug or implements
3030
new functionality. Reviews of pull requests ensure that they are implemented
@@ -146,7 +146,7 @@ Pick a pull request from the `PRs in need of review`_ and follow these steps:
146146
* Does the PR stay within scope to address *only* that issue?
147147
* Does the PR contain automated tests? Do those tests cover all relevant
148148
edge cases?
149-
* Does the PR contain sufficient comments to easily understand its code?
149+
* Does the PR contain sufficient comments to understand its code?
150150
* Does the code break backward compatibility? If yes, does the PR header say
151151
so?
152152
* Does the PR contain deprecations? If yes, does the PR header say so? Does

controller.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ the argument by its name:
335335
])
336336
;
337337
338-
You can of course also use normal :ref:`constructor injection <services-constructor-injection>`
338+
You can also use normal :ref:`constructor injection <services-constructor-injection>`
339339
in your controllers.
340340

341341
.. caution::

controller/error_pages.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -248,8 +248,8 @@ will be passed two parameters:
248248
A :class:`\\Symfony\\Component\\HttpKernel\\Log\\DebugLoggerInterface`
249249
instance which may be ``null`` in some circumstances.
250250

251-
Instead of creating a new exception controller from scratch you can, of course,
252-
also extend the default :class:`Symfony\\Bundle\\TwigBundle\\Controller\\ExceptionController`.
251+
Instead of creating a new exception controller from scratch you can also extend
252+
the default :class:`Symfony\\Bundle\\TwigBundle\\Controller\\ExceptionController`.
253253
In that case, you might want to override one or both of the ``showAction()`` and
254254
``findTemplate()`` methods. The latter one locates the template to be used.
255255

controller/soap_web_service.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
How to Create a SOAP Web Service in a Symfony Controller
77
========================================================
88

9-
Setting up a controller to act as a SOAP server is simple with a couple
10-
tools. You must, of course, have the `PHP SOAP`_ extension installed.
11-
As the PHP SOAP extension cannot currently generate a WSDL, you must either
12-
create one from scratch or use a 3rd party generator.
9+
Setting up a controller to act as a SOAP server is simple with a couple tools.
10+
You must have the `PHP SOAP`_ extension installed. As the PHP SOAP extension
11+
cannot currently generate a WSDL, you must either create one from scratch or use
12+
a 3rd party generator.
1313

1414
.. note::
1515

create_framework/event_dispatcher.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,8 +247,8 @@ issue: the knowledge of the priorities is "hardcoded" in the front controller,
247247
instead of being in the listeners themselves. For each application, you have
248248
to remember to set the appropriate priorities. Moreover, the listener method
249249
names are also exposed here, which means that refactoring our listeners would
250-
mean changing all the applications that rely on those listeners. Of course,
251-
there is a solution: use subscribers instead of listeners::
250+
mean changing all the applications that rely on those listeners. But there is a
251+
solution: use subscribers instead of listeners::
252252

253253
$dispatcher = new EventDispatcher();
254254
$dispatcher->addSubscriber(new Simplex\ContentLengthListener());

0 commit comments

Comments
 (0)