Skip to content

Commit 7a61870

Browse files
committed
Merge branch '6.1' into 6.2
* 6.1: Some text improvements
2 parents 89d56f6 + 86f08de commit 7a61870

File tree

4 files changed

+25
-25
lines changed

4 files changed

+25
-25
lines changed

LICENSE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ b. You may Distribute or Publicly Perform an Adaptation only under the terms of:
195195
(i) this License; (ii) a later version of this License with the same License
196196
Elements as this License; (iii) a Creative Commons jurisdiction license (either
197197
this or a later license version) that contains the same License Elements as this
198-
License (e.g., Attribution-ShareAlike 3.0 US)); (iv) a Creative Commons
198+
License (e.g. Attribution-ShareAlike 3.0 US)); (iv) a Creative Commons
199199
Compatible License. If you license the Adaptation under one of the licenses
200200
mentioned in (iv), you must comply with the terms of that license. If you
201201
license the Adaptation under the terms of any of the licenses mentioned in (i),
@@ -221,15 +221,15 @@ Collections, You must, unless a request has been made pursuant to Section 4(a),
221221
keep intact all copyright notices for the Work and provide, reasonable to the
222222
medium or means You are utilizing: (i) the name of the Original Author (or
223223
pseudonym, if applicable) if supplied, and/or if the Original Author and/or
224-
Licensor designate another party or parties (e.g., a sponsor institute,
224+
Licensor designate another party or parties (e.g. a sponsor institute,
225225
publishing entity, journal) for attribution ("Attribution Parties") in
226226
Licensor's copyright notice, terms of service or by other reasonable means, the
227227
name of such party or parties; (ii) the title of the Work if supplied; (iii) to
228228
the extent reasonably practicable, the URI, if any, that Licensor specifies to
229229
be associated with the Work, unless such URI does not refer to the copyright
230230
notice or licensing information for the Work; and (iv) , consistent with Section
231231
3(b), in the case of an Adaptation, a credit identifying the use of the Work in
232-
the Adaptation (e.g., "French translation of the Work by Original Author," or
232+
the Adaptation (e.g. "French translation of the Work by Original Author," or
233233
"Screenplay based on original Work by Original Author"). The credit required by
234234
this Section 4(c) may be implemented in any reasonable manner; provided,
235235
however, that in the case of a Adaptation or Collection, at a minimum such

best_practices.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Use Environment Variables for Infrastructure Configuration
8282
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8383

8484
The values of these options change from one machine to another (e.g. from your
85-
development machine to the production server) but they don't modify the
85+
development machine to the production server), but they don't modify the
8686
application behavior.
8787

8888
:ref:`Use env vars in your project <config-env-vars>` to define these options
@@ -93,7 +93,7 @@ and create multiple ``.env`` files to :ref:`configure env vars per environment <
9393
Use Secrets for Sensitive Information
9494
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9595

96-
When your application has sensitive configuration - like an API key - you should
96+
When your application has sensitive configuration, like an API key, you should
9797
store those securely via :doc:`Symfony’s secrets management system </configuration/secrets>`.
9898

9999
Use Parameters for Application Configuration
@@ -119,7 +119,7 @@ Then, use just one or two words to describe the purpose of the parameter:
119119
120120
# config/services.yaml
121121
parameters:
122-
# don't do this: 'dir' is too generic and it doesn't convey any meaning
122+
# don't do this: 'dir' is too generic, and it doesn't convey any meaning
123123
app.dir: '...'
124124
# do this: short but easy to understand names
125125
app.contents_dir: '...'
@@ -164,7 +164,7 @@ InvoiceBundle, etc. However, a bundle is meant to be something that can be
164164
reused as a stand-alone piece of software.
165165

166166
If you need to reuse some feature in your projects, create a bundle for it (in a
167-
private repository, to not make it publicly available). For the rest of your
167+
private repository, do not make it publicly available). For the rest of your
168168
application code, use PHP namespaces to organize code instead of bundles.
169169

170170
Use Autowiring to Automate the Configuration of Application Services
@@ -186,14 +186,14 @@ Services Should be Private Whenever Possible
186186
those services via ``$container->get()``. Instead, you will need to use proper
187187
dependency injection.
188188

189-
Use the YAML Format to Configure your Own Services
189+
Use the YAML Format to Configure your own Services
190190
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
191191

192192
If you use the :ref:`default services.yaml configuration <service-container-services-load-example>`,
193193
most services will be configured automatically. However, in some edge cases
194194
you'll need to configure services (or parts of them) manually.
195195

196-
YAML is the format recommended to configure services because it's friendly to
196+
YAML is the format recommended configuring services because it's friendly to
197197
newcomers and concise, but Symfony also supports XML and PHP configuration.
198198

199199
Use Attributes to Define the Doctrine Entity Mapping
@@ -228,13 +228,13 @@ important parts of your application.
228228

229229
.. _best-practice-controller-annotations:
230230

231-
Use Attributes or Annotations to Configure Routing, Caching and Security
231+
Use Attributes or Annotations to Configure Routing, Caching, and Security
232232
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
233233

234-
Using attributes or annotations for routing, caching and security simplifies
234+
Using attributes or annotations for routing, caching, and security simplifies
235235
configuration. You don't need to browse several files created with different
236-
formats (YAML, XML, PHP): all the configuration is just where you need it and
237-
it only uses one format.
236+
formats (YAML, XML, PHP): all the configuration is just where you require it,
237+
and it only uses one format.
238238

239239
Use Dependency Injection to Get Services
240240
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -264,7 +264,7 @@ Templates
264264
Use Snake Case for Template Names and Variables
265265
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
266266

267-
Use lowercase snake_case for template names, directories and variables (e.g.
267+
Use lowercase snake_case for template names, directories, and variables (e.g.
268268
``user_profile`` instead of ``userProfile`` and ``product/edit_form.html.twig``
269269
instead of ``Product/EditForm.html.twig``).
270270

@@ -282,7 +282,7 @@ Forms
282282
Define your Forms as PHP Classes
283283
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
284284

285-
Creating :ref:`forms in classes <creating-forms-in-classes>` allows to reuse
285+
Creating :ref:`forms in classes <creating-forms-in-classes>` allows reusing
286286
them in different parts of the application. Besides, not creating forms in
287287
controllers simplifies the code and maintenance of the controllers.
288288

@@ -294,7 +294,7 @@ button of a form used to both create and edit items should change from "Add new"
294294
to "Save changes" depending on where it's used.
295295

296296
Instead of adding buttons in form classes or the controllers, it's recommended
297-
to add buttons in the templates. This also improves the separation of concerns,
297+
to add buttons in the templates. This also improves the separation of concerns
298298
because the button styling (CSS class and other attributes) is defined in the
299299
template instead of in a PHP class.
300300

@@ -316,7 +316,7 @@ Use a Single Action to Render and Process the Form
316316

317317
:ref:`Rendering forms <rendering-forms>` and :ref:`processing forms <processing-forms>`
318318
are two of the main tasks when handling forms. Both are too similar (most of the
319-
times, almost identical), so it's much simpler to let a single controller action
319+
time, almost identical), so it's much simpler to let a single controller action
320320
handle both.
321321

322322
.. _best-practice-internationalization:
@@ -340,8 +340,8 @@ Use Keys for Translations Instead of Content Strings
340340
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
341341

342342
Using keys simplifies the management of the translation files because you can
343-
change the original contents in templates, controllers and services without
344-
having to update all of the translation files.
343+
change the original contents in templates, controllers, and services without
344+
having to update all the translation files.
345345

346346
Keys should always describe their *purpose* and *not* their location. For
347347
example, if a form has a field with the label "Username", then a nice key
@@ -381,13 +381,13 @@ Web Assets
381381
Use Webpack Encore to Process Web Assets
382382
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
383383

384-
Web assets are things like CSS, JavaScript and image files that make the
384+
Web assets are things like CSS, JavaScript, and image files that make the
385385
frontend of your site look and work great. `Webpack`_ is the leading JavaScript
386386
module bundler that compiles, transforms and packages assets for usage in a browser.
387387

388388
:doc:`Webpack Encore </frontend>` is a JavaScript library that gets rid of most
389389
of Webpack complexity without hiding any of its features or distorting its usage
390-
and philosophy. It was originally created for Symfony applications, but it works
390+
and philosophy. It was created for Symfony applications, but it works
391391
for any application using any technology.
392392

393393
Tests
@@ -445,7 +445,7 @@ public URL changes, users won't be able to browse it unless you set up a
445445
redirection to the new URL.
446446

447447
That's why it's recommended to use raw URLs in tests instead of generating them
448-
from routes. Whenever a route changes, tests will fail and you'll know that
448+
from routes. Whenever a route changes, tests will fail, and you'll know that
449449
you must set up a redirection.
450450

451451
.. _`Symfony Demo`: https://github.com/symfony/demo

contributing/code/security.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ score for Impact is capped at 6. Each area is scored between 0 and 4.*
152152
on an end-users system, or the server that it runs on? (0-4)
153153
* Availability: Is the availability of a service or application affected? Is
154154
it reduced availability or total loss of availability of a service /
155-
application? Availability includes networked services (e.g., databases) or
155+
application? Availability includes networked services (e.g. databases) or
156156
resources such as consumption of network bandwidth, processor cycles, or
157157
disk space. (0-4)
158158

translation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -717,10 +717,10 @@ configure the ``providers`` option:
717717
718718
.. tip::
719719

720-
If you use Lokalise as provider and a locale format following the `ISO 639-1`_ (e.g., "en" or "fr"),
720+
If you use Lokalise as provider and a locale format following the `ISO 639-1`_ (e.g. "en" or "fr"),
721721
you have to set the `Custom Language Name setting`_ in Lokalise for each of your locales,
722722
in order to override the default value (which follow the `ISO 639-1`_ succeeded by a sub-code
723-
in capital letters that specifies the national variety (e.g., "GB" or "US" according to `ISO 3166-1 alpha-2`_)).
723+
in capital letters that specifies the national variety (e.g. "GB" or "US" according to `ISO 3166-1 alpha-2`_)).
724724

725725
Pushing and Pulling Translations
726726
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)