Skip to content

Removed more belittling words and expressions #11568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _build/maintainer_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ Step 2: Merge the pull request
Never use GitHub's web interface (or desktop clients) to merge PRs or to solve
merge conflicts. Always use the ``gh`` tool for anything related to merges.

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

If a PR contains lots of commits, there's no need to ask the contributor to
squash them. The ``gh`` tool does that automatically. The only exceptions are
Expand Down
7 changes: 3 additions & 4 deletions best_practices/business-logic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,8 @@ distributed among developers, with a slight preference towards YAML.
Both formats have the same performance, so this is ultimately a matter of
personal taste.

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

Service: No Class Parameter
---------------------------
Expand Down Expand Up @@ -218,8 +218,7 @@ The three entities defined by our sample blog application are a good example:

.. tip::

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

Doctrine Mapping Information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
6 changes: 3 additions & 3 deletions best_practices/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ Constants can be used for example in your Twig templates thanks to the
Displaying the {{ constant('NUMBER_OF_ITEMS', post) }} most recent results.
</p>

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

namespace AppBundle\Repository;

Expand All @@ -149,7 +149,7 @@ whereas they cannot access the container parameters::
}

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

Parameter Naming
----------------
Expand Down
8 changes: 4 additions & 4 deletions best_practices/controllers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ The ``@Template`` annotation is useful, but also involves some magic. We
don't think its benefit is worth the magic, and so recommend against using
it.

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

What does the Controller look like
----------------------------------
Expand Down
9 changes: 4 additions & 5 deletions best_practices/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,10 @@ of these best practices. But by following these, you'll be able to develop
applications faster, with less complexity and with the same or even higher
quality. It's also a moving target that will continue to improve.

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

Who this Book Is for (Hint: It's not a Tutorial)
------------------------------------------------
Expand Down
8 changes: 4 additions & 4 deletions best_practices/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ primarily under the ``firewalls`` key.
API only), we recommend having only *one* firewall entry with the ``anonymous``
key enabled.

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

Additionally, you should use the ``anonymous`` key under your firewall. If
you need to require users to be logged in for different sections of your
Expand Down
4 changes: 2 additions & 2 deletions best_practices/tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@ The built-in functional testing client is great, but it can't be used to
test any JavaScript behavior on your pages. If you need to test this, consider
using the `Mink`_ library from within PHPUnit.

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

Learn More about Functional Tests
---------------------------------
Expand Down
2 changes: 1 addition & 1 deletion components/console/single_command_tool.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The method :method:`Symfony\\Component\\Console\\Application::setDefaultCommand`
accepts a boolean as second parameter. If true, the command ``echo`` will then
always be used, without having to pass its name.

Of course, you can still register a command as usual::
You can still register a command as usual::

#!/usr/bin/env php
<?php
Expand Down
2 changes: 1 addition & 1 deletion components/dom_crawler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The :class:`Symfony\\Component\\DomCrawler\\Crawler` class provides methods
to query and manipulate HTML and XML documents.

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

use Symfony\Component\DomCrawler\Crawler;

Expand Down
2 changes: 1 addition & 1 deletion components/expression_language/extending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ or by using the second argument of the constructor::
{
public function __construct(ParserCacheInterface $parser = null, array $providers = [])
{
// prepends the default provider to let users override it easily
// prepends the default provider to let users override it
array_unshift($providers, new StringExpressionLanguageProvider());

parent::__construct($parser, $providers);
Expand Down
10 changes: 5 additions & 5 deletions components/form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
The Form Component
==================

The Form component allows you to easily create, process and reuse forms.
The Form component allows you to create, process and reuse forms.

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

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

To use the integration, you'll need the twig bridge, which provides integration
between Twig and several Symfony components:
Expand Down
2 changes: 1 addition & 1 deletion components/http_foundation/session_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ handlers by providing six callback functions which PHP calls internally at
various points in the session workflow.

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

* :class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\Handler\\PdoSessionHandler`
* :class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\Handler\\MemcacheSessionHandler`
Expand Down
4 changes: 2 additions & 2 deletions components/http_foundation/session_testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Testing with Sessions
=====================

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

Testing code using real sessions is tricky because PHP's workflow state is global
and it is not possible to have multiple concurrent sessions in the same PHP
Expand Down
2 changes: 1 addition & 1 deletion components/http_kernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This is a simplified overview of the request workflow in Symfony applications:
#. The **browser** displays the **resource** to the **user**.

Typically, some sort of framework or system is built to handle all the repetitive
tasks (e.g. routing, security, etc) so that a developer can easily build
tasks (e.g. routing, security, etc) so that a developer can build
each *page* of the application. Exactly *how* these systems are built varies
greatly. The HttpKernel component provides an interface that formalizes
the process of starting with a request and creating the appropriate response.
Expand Down
2 changes: 1 addition & 1 deletion components/options_resolver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ method ``clearOptionsConfig()`` and call it periodically::
// ...
}

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

.. _Packagist: https://packagist.org/packages/symfony/options-resolver
Expand Down
2 changes: 1 addition & 1 deletion components/security/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ authentication providers, each supporting a different type of token.

.. note::

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

.. _authentication_providers:
Expand Down
4 changes: 2 additions & 2 deletions components/security/authorization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,8 @@ role::

.. note::

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

Roles
-----
Expand Down
8 changes: 4 additions & 4 deletions configuration/environments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ As you can see, when Symfony is loaded, it uses the given environment to
determine which configuration file to load. This accomplishes the goal of
multiple environments in an elegant, powerful and transparent way.

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

.. configuration-block::

Expand Down Expand Up @@ -283,7 +283,7 @@ Creating a new Environment
--------------------------

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

Expand Down Expand Up @@ -420,7 +420,7 @@ includes the following:

.. note::

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

Going further
Expand Down
12 changes: 6 additions & 6 deletions configuration/front_controllers_and_kernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ to decide which bundles to create. The logic for that is in ``registerBundles()`
a method meant to be extended by you when you start adding bundles to your
application.

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

.. note::

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

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

.. _front controller: https://en.wikipedia.org/wiki/Front_Controller_pattern
.. _Symfony Standard Edition: https://github.com/symfony/symfony-standard
Expand Down
2 changes: 1 addition & 1 deletion contributing/code/bc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ method signature.

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

That's why we created this page for you. The section "Using Symfony Code" will
tell you how you can ensure that your application won't break completely when
Expand Down
4 changes: 2 additions & 2 deletions contributing/code/git.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Pull Requests
Whenever a pull request is merged, all the information contained in the pull
request (including comments) is saved in the repository.

You can easily spot pull request merges as the commit message always follows
this pattern:
You can spot pull request merges as the commit message always follows this
pattern:

.. code-block:: text

Expand Down
10 changes: 5 additions & 5 deletions contributing/code/reproducer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ Creating a Bug Reproducer
=========================

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

Reproducing Simple Bugs
-----------------------
Expand Down
4 changes: 2 additions & 2 deletions contributing/community/reviews.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ On the `Symfony issue tracker`_, you can find many items in a `Needs Review`_
status:

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

* **Pull Requests**: Pull requests contain code that fixes a bug or implements
new functionality. Reviews of pull requests ensure that they are implemented
Expand Down Expand Up @@ -146,7 +146,7 @@ Pick a pull request from the `PRs in need of review`_ and follow these steps:
* Does the PR stay within scope to address *only* that issue?
* Does the PR contain automated tests? Do those tests cover all relevant
edge cases?
* Does the PR contain sufficient comments to easily understand its code?
* Does the PR contain sufficient comments to understand its code?
* Does the code break backward compatibility? If yes, does the PR header say
so?
* Does the PR contain deprecations? If yes, does the PR header say so? Does
Expand Down
2 changes: 1 addition & 1 deletion controller.rst
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ the argument by its name:
])
;

You can of course also use normal :ref:`constructor injection <services-constructor-injection>`
You can also use normal :ref:`constructor injection <services-constructor-injection>`
in your controllers.

.. caution::
Expand Down
4 changes: 2 additions & 2 deletions controller/error_pages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -248,8 +248,8 @@ will be passed two parameters:
A :class:`\\Symfony\\Component\\HttpKernel\\Log\\DebugLoggerInterface`
instance which may be ``null`` in some circumstances.

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

Expand Down
8 changes: 4 additions & 4 deletions controller/soap_web_service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
How to Create a SOAP Web Service in a Symfony Controller
========================================================

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

.. note::

Expand Down
4 changes: 2 additions & 2 deletions create_framework/event_dispatcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -247,8 +247,8 @@ issue: the knowledge of the priorities is "hardcoded" in the front controller,
instead of being in the listeners themselves. For each application, you have
to remember to set the appropriate priorities. Moreover, the listener method
names are also exposed here, which means that refactoring our listeners would
mean changing all the applications that rely on those listeners. Of course,
there is a solution: use subscribers instead of listeners::
mean changing all the applications that rely on those listeners. But there is a
solution: use subscribers instead of listeners::

$dispatcher = new EventDispatcher();
$dispatcher->addSubscriber(new Simplex\ContentLengthListener());
Expand Down
Loading