8000 review single doc pages for belittling words · symfony/symfony-docs@1f4ce3b · GitHub
[go: up one dir, main page]
Skip to content

Commit 1f4ce3b

Browse files
dbudbu
committed
review single doc pages for belittling words
1 parent 4f9ad67 commit 1f4ce3b

13 files changed

+34
-33
lines changed

‎bundles.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ file::
4444
Creating a Bundle
4545
-----------------
4646

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

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

9191
``Controller/``

‎deployment.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Using Source Control
5353

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

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

8080
`EasyDeployBundle`_
81-
A Symfony bundle that adds easy deploy tools to your application.
81+
A Symfony bundle that adds deploy tools to your application.
8282

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

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

110110
Common Post-Deployment Tasks
@@ -152,7 +152,7 @@ C) Install/Update your Vendors
152152

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

158158
.. code-block:: terminal

‎doctrine.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -203,8 +203,9 @@ Migrations: Creating the Database Tables/Schema
203203
-----------------------------------------------
204204

205205
The ``Product`` class is fully-configured and r 57AE eady to save to a ``product`` table.
206-
Of course, your database doesn't actually have the ``product`` table yet. To add
207-
it, you can leverage the `DoctrineMigrationsBundle`_, which is already installed:
206+
If you just defined this class, your database doesn't actually have the ``product``
207+
table yet. To add it, you can leverage the `DoctrineMigrationsBundle`_, which is
208+
already installed:
208209

209210
.. code-block:: terminal
210211
@@ -234,7 +235,7 @@ Migrations & Adding more Fields
234235
-------------------------------
235236

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

240241
.. code-block:: terminal
@@ -278,7 +279,7 @@ methods:
278279
}
279280
280281
The new property is mapped, but it doesn't exist yet in the ``product`` table. No
281-
problem! Just generate a new migration:
282+
problem! Generate a new migration:
282283

283284
.. code-block:: terminal
284285
@@ -291,7 +292,7 @@ This time, the SQL in the generated file will look like this:
291292
ALTER TABLE product ADD description LONGTEXT NOT NULL
292293
293294
The migration system is *smart*. It compares all of your entities with the current
294-
state of the database and generates the SQL needed to synchronize them! Just like
295+
state of the database and generates the SQL needed to synchronize them! Like
295296
before, execute your migrations:
296297

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

527-
Once you've fetched an object from Doctrine, updating it is easy::
528+
Once you've fetched an object from Doctrine, you interact with it the same as
529+
with any PHP model::
528530

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

551-
Updating an object involves just three steps:
553+
Using doctrine to edit an existing product consists of three steps:
552554

553555
#. fetching the object from Doctrine;
554556
#. modifying the object;

‎email.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,8 @@ Using Cloud Services to Send Emails
138138
-----------------------------------
139139

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

145145
.. code-block:: bash

‎event_dispatcher.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The most common way to listen to an event is to register an **event listener**::
6767
Check out the :doc:`Symfony events reference </reference/events>` to see
6868
what type of object each event provides.
6969

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

‎forms.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ going to need to build a form. But before you begin, first focus on the generic
7171
}
7272

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

@@ -614,7 +614,7 @@ that will house the logic for building the task form::
614614
}
615615

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

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

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

‎logging.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ Linux command to rotate log files before they become too large.
277277

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

283283
.. configuration-block::

‎routing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -794,7 +794,7 @@ The ``controller`` value in your routes has the format ``CONTROLLER_CLASS::METHO
794794
.. tip::
795795

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

800800
.. index::

‎security.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,7 @@ See :doc:`/security/access_control`.
540540
Securing Controllers and other Code
541541
...................................
542542

543-
You can easily deny access from inside a controller::
543+
You can deny access from inside a controller::
544544

545545
// src/Controller/AdminController.php
546546
// ...

‎service_container.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -803,7 +803,7 @@ As a best practice, you should only create *private* services, which will happen
803803
automatically. And also, you should *not* use the ``$container->get()`` method to
804804
fetch public services.
805805

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

808808
.. configuration-block::
809809

‎testing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Just like in your real application - autoloading is automatically enabled
104104
via the ``vendor/autoload.php`` file (as configured by default in the
105105
``phpunit.xml.dist`` file).
106106

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

109109
.. code-block:: terminal
110110
@@ -150,7 +150,7 @@ First, install the BrowserKit component in your project:
150150
151151
$ composer require --dev symfony/browser-kit
152152
153-
Functional tests are simple PHP files that typically live in the ``tests/Controller``
153+
Functional tests are PHP files that typically live in the ``tests/Controller``
154154
directory for your bundle. If you want to test the pages handled by your
155155
``PostController`` class, start by creating a new ``PostControllerTest.php``
156156
file that extends a special ``WebTestCase`` class.
@@ -993,7 +993,7 @@ as configured in the ``phpunit.xml.dist`` file:
993993
<!-- ... -->
994994
</phpunit>
995995
996-
But you can easily add more directories. For instance, the following
996+
But you can add more directories. For instance, the following
997997
configuration adds tests from a custom ``lib/tests`` directory:
998998

999999
.. code-block:: xml

‎translation.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ the message inside your :ref:`templates <translation-tags>`.
177177
The Translation Process
178178
~~~~~~~~~~~~~~~~~~~~~~~
179179

180-
To actually translate the message, Symfony uses a simple process:
18 DA40 0+
To actually translate the message, Symfony uses the following process:
181181

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

@@ -525,8 +525,7 @@ Summary
525525
-------
526526

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

531530
* Abstract messages in your application by wrapping each in either the
532531
:method:`Symfony\\Component\\Translation\\Translator::trans` or

‎validation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ Using the ``validator`` Service
122122

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

0 commit comments

Comments
 (0)
0