Skip to content

review single doc pages for belittling words #10585

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

Merged
merged 1 commit into from
Oct 26, 2018
Merged
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
8 changes: 4 additions & 4 deletions bundles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ file::
Creating a Bundle
-----------------

This section creates and enables a new bundle to show how simple it is to do it.
This section creates and enables a new bundle to show there are only a few steps required.
The new bundle is called AcmeTestBundle, where the ``Acme`` portion is just a
dummy name that should be replaced by some "vendor" name that represents you or
your organization (e.g. ABCTestBundle for some company named ``ABC``).
Expand Down Expand Up @@ -83,9 +83,9 @@ And while it doesn't do anything yet, AcmeTestBundle is now ready to be used.
Bundle Directory Structure
--------------------------

The directory structure of a bundle is simple and flexible. By default, the
bundle system follows a set of conventions that help to keep code consistent
between all Symfony bundles. Take a look at AcmeDemoBundle, as it contains some
The directory structure of a bundle is meant to help to keep code consistent
between all Symfony bundles. It follows a set of conventions, but is flexible
to be adjusted if needed. Take a look at AcmeDemoBundle, as it contains some
of the most common elements of a bundle:

``Controller/``
Expand Down
8 changes: 4 additions & 4 deletions deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Using Source Control

If you're using source control (e.g. Git or SVN), you can simplify by having
your live installation also be a copy of your repository. When you're ready to
upgrade it is as simple as fetching the latest updates from your source control
upgrade, fetch the latest updates from your source control
system. When using Git, a common approach is to create a tag for each release
and check out the appropriate tag on deployment (see `Git Tagging`_).

Expand All @@ -78,7 +78,7 @@ There are also tools to help ease the pain of deployment. Some of them have been
specifically tailored to the requirements of Symfony.

`EasyDeployBundle`_
A Symfony bundle that adds easy deploy tools to your application.
A Symfony bundle that adds deploy tools to your application.

`Deployer`_
This is another native PHP rewrite of Capistrano, with some ready recipes for
Expand All @@ -104,7 +104,7 @@ specifically tailored to the requirements of Symfony.
Helps you build a native Debian package for your Symfony project.

Basic scripting
You can of course use shell, `Ant`_ or any other build tool to script
You can use a shell script, `Ant`_ or any other build tool to script
the deploying of your project.

Common Post-Deployment Tasks
Expand Down Expand Up @@ -152,7 +152,7 @@ C) Install/Update your Vendors

Your vendors can be updated before transferring your source code (i.e.
update the ``vendor/`` directory, then transfer that with your source
code) or afterwards on the server. Either way, just update your vendors
code) or afterwards on the server. Either way, update your vendors
as you normally do:

.. code-block:: terminal
Expand Down
16 changes: 9 additions & 7 deletions doctrine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,8 +203,9 @@ Migrations: Creating the Database Tables/Schema
-----------------------------------------------

The ``Product`` class is fully-configured and ready to save to a ``product`` table.
Of course, your database doesn't actually have the ``product`` table yet. To add
it, you can leverage the `DoctrineMigrationsBundle`_, which is already installed:
If you just defined this class, your database doesn't actually have the ``product``
table yet. To add it, you can leverage the `DoctrineMigrationsBundle`_, which is
already installed:

.. code-block:: terminal

Expand Down Expand Up @@ -234,7 +235,7 @@ Migrations & Adding more Fields
-------------------------------

But what if you need to add a new field property to ``Product``, like a ``description``?
It's easy to add the new property by hand. But, you can also use ``make:entity``
You can edit the class to add the new property. But, you can also use ``make:entity``
again:

.. code-block:: terminal
Expand Down Expand Up @@ -278,7 +279,7 @@ methods:
}

The new property is mapped, but it doesn't exist yet in the ``product`` table. No
problem! Just generate a new migration:
problem! Generate a new migration:

.. code-block:: terminal

Expand All @@ -291,7 +292,7 @@ This time, the SQL in the generated file will look like this:
ALTER TABLE product ADD description LONGTEXT NOT NULL

The migration system is *smart*. It compares all of your entities with the current
state of the database and generates the SQL needed to synchronize them! Just like
state of the database and generates the SQL needed to synchronize them! Like
before, execute your migrations:

.. code-block:: terminal
Expand Down Expand Up @@ -524,7 +525,8 @@ There are many more options you can use. Read more about the `ParamConverter`_.
Updating an Object
------------------

Once you've fetched an object from Doctrine, updating it is easy::
Once you've fetched an object from Doctrine, you interact with it the same as
with any PHP model::

/**
* @Route("/product/edit/{id}")
Expand All @@ -548,7 +550,7 @@ Once you've fetched an object from Doctrine, updating it is easy::
]);
}

Updating an object involves just three steps:
Using doctrine to edit an existing product consists of three steps:

#. fetching the object from Doctrine;
#. modifying the object;
Expand Down
4 changes: 2 additions & 2 deletions email.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@ Using Cloud Services to Send Emails
-----------------------------------

Cloud mailing services are a popular option for companies that don't want to set
up and maintain their own reliable mail servers. In Symfony apps, using these
services is as simple as updating the value of ``MAILER_URL`` in the ``.env``
up and maintain their own reliable mail servers. To use these services in a
Symfony app, update the value of ``MAILER_URL`` in the ``.env``
file. For example, for `Amazon SES`_ (Simple Email Service):

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion event_dispatcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The most common way to listen to an event is to register an **event listener**::
Check out the :doc:`Symfony events reference </reference/events>` to see
what type of object each event provides.

Now that the class is created, you just need to register it as a service and
Now that the class is created, you need to register it as a service and
notify Symfony that it is a "listener" on the ``kernel.exception`` event by
using a special "tag":

Expand Down
8 changes: 4 additions & 4 deletions forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ going to need to build a form. But before you begin, first focus on the generic
}

This class is a "plain-old-PHP-object" because, so far, it has nothing
to do with Symfony or any other library. It's quite simply a normal PHP object
to do with Symfony or any other library. It's a normal PHP object
that directly solves a problem inside *your* application (i.e. the need to
represent a task in your application). Of course, by the end of this article,
represent a task in your application). By the end of this article,
you'll be able to submit data to a ``Task`` instance (via an HTML form), validate
its data and persist it to the database.

Expand Down Expand Up @@ -614,7 +614,7 @@ that will house the logic for building the task form::
}

This new class contains all the directions needed to create the task form. It can
be used to quickly build a form object in the controller::
be used to build a form object in the controller::

// src/Controller/DefaultController.php
use App\Form\TaskType;
Expand All @@ -627,7 +627,7 @@ be used to quickly build a form object in the controller::
// ...
}

Placing the form logic into its own class means that the form can be easily
Placing the form logic into its own class means that the form can be
reused elsewhere in your project. This is the best way to create forms, but
the choice is ultimately up to you.

Expand Down
2 changes: 1 addition & 1 deletion logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ Linux command to rotate log files before they become too large.

Another option is to have Monolog rotate the files for you by using the
``rotating_file`` handler. This handler creates a new log file every day
and can also remove old files automatically. To use it, just set the ``type``
and can also remove old files automatically. To use it, set the ``type``
option of your handler to ``rotating_file``:

.. configuration-block::
Expand Down
2 changes: 1 addition & 1 deletion routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -794,7 +794,7 @@ The ``controller`` value in your routes has the format ``CONTROLLER_CLASS::METHO
.. tip::

To refer to an action that is implemented as the ``__invoke()`` method of a controller class,
you do not have to pass the method name, but can just use the fully qualified class name (e.g.
you do not have to pass the method name, you can also use the fully qualified class name (e.g.
``App\Controller\BlogController``).

.. index::
Expand Down
2 changes: 1 addition & 1 deletion security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,7 @@ See :doc:`/security/access_control`.
Securing Controllers and other Code
...................................

You can easily deny access from inside a controller::
You can deny access from inside a controller::

// src/Controller/AdminController.php
// ...
Expand Down
2 changes: 1 addition & 1 deletion service_container.rst
Original file line number Diff line number Diff line change
Expand Up @@ -803,7 +803,7 @@ As a best practice, you should only create *private* services, which will happen
automatically. And also, you should *not* use the ``$container->get()`` method to
fetch public services.

But, if you *do* need to make a service public, just override the ``public`` setting:
But, if you *do* need to make a service public, override the ``public`` setting:

.. configuration-block::

Expand Down
6 changes: 3 additions & 3 deletions testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Just like in your real application - autoloading is automatically enabled
via the ``vendor/autoload.php`` file (as configured by default in the
``phpunit.xml.dist`` file).

Running tests for a given file or directory is also very easy:
You can also limit a test run to a directory or only a specific test file:

.. code-block:: terminal

Expand Down Expand Up @@ -150,7 +150,7 @@ First, install the BrowserKit component in your project:

$ composer require --dev symfony/browser-kit

Functional tests are simple PHP files that typically live in the ``tests/Controller``
Functional tests are PHP files that typically live in the ``tests/Controller``
directory for your bundle. If you want to test the pages handled by your
``PostController`` class, start by creating a new ``PostControllerTest.php``
file that extends a special ``WebTestCase`` class.
Expand Down Expand Up @@ -993,7 +993,7 @@ as configured in the ``phpunit.xml.dist`` file:
<!-- ... -->
</phpunit>

But you can easily add more directories. For instance, the following
But you can add more directories. For instance, the following
configuration adds tests from a custom ``lib/tests`` directory:

.. code-block:: xml
Expand Down
5 changes: 2 additions & 3 deletions translation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ the message inside your :ref:`templates <translation-tags>`.
The Translation Process
~~~~~~~~~~~~~~~~~~~~~~~

To actually translate the message, Symfony uses a simple process:
To actually translate the message, Symfony uses the following process:

* The ``locale`` of the current user, which is stored on the request is determined;

Expand Down Expand Up @@ -525,8 +525,7 @@ Summary
-------

With the Symfony Translation component, creating an internationalized application
no longer needs to be a painful process and boils down to just a few basic
steps:
no longer needs to be a painful process and boils down to these steps:

* Abstract messages in your application by wrapping each in either the
:method:`Symfony\\Component\\Translation\\Translator::trans` or
Expand Down
2 changes: 1 addition & 1 deletion validation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Using the ``validator`` Service

Next, to actually validate an ``Author`` object, use the ``validate()`` method
on the ``validator`` service (class :class:`Symfony\\Component\\Validator\\Validator`).
The job of the ``validator`` is easy: to read the constraints (i.e. rules)
The job of the ``validator`` is to read the constraints (i.e. rules)
of a class and verify if the data on the object satisfies those
constraints. If validation fails, a non-empty list of errors
(class :class:`Symfony\\Component\\Validator\\ConstraintViolationList`) is
Expand Down