8000 Merge branch '4.4' · symfony/symfony-docs@2b45346 · GitHub
[go: up one dir, main page]

Skip to content

Commit 2b45346

10000
Browse files
committed
Merge branch '4.4'
* 4.4: Add missing semicolon Minor tweak Add parentheses after require() function name Fixes a typo in expiration.rst Note doctrine bundle version for middlewares [Workflow] Fixed PHP config of workflow marking store Remove assumption about why people read the documentation Fix a few misprints Update templates.rst
2 parents a11e749 + 5de2dd3 commit 2b45346

File tree

7 files changed

+20
-17
lines changed

7 files changed

+20
-17
lines changed

components/http_client.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -676,7 +676,7 @@ interface you need to code against when a client is needed::
676676

677677
public function __construct(HttpClientInterface $client)
678678
{
679-
$this->client = $client
679+
$this->client = $client;
680680
}
681681

682682
// [...]

contributing/documentation/standards.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -173,11 +173,10 @@ In addition, documentation follows these rules:
173173
* his or hers, use theirs
174174
* himself or herself, use themselves
175175

176-
* **Avoid belittling words**: People read documentation because they know very
177-
little about a specific topic or are even completely new to it. Things that
178-
seem "obvious" or "simple" for the person documenting it, can be the exact
179-
opposite for the reader. To make sure everybody feels comfortable when reading
180-
the documentation, try to avoid words like:
176+
* **Avoid belittling words**: Things that seem "obvious" or "simple" for the
177+
person documenting it, can be the exact opposite for the reader. To make sure
178+
everybody feels comfortable when reading the documentation, try to avoid words
179+
like:
181180

182181
* basically
183182
* clearly

frontend/encore/simple-example.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ CSS and one JS file, organized into an ``assets/`` directory:
1010
With Encore, think of your ``app.js`` file like a standalone JavaScript
1111
application: it will *require* all of the dependencies it needs (e.g. jQuery or React),
1212
*including* any CSS. Your ``app.js`` file is already doing this with a special
13-
``require`` function:
13+
``require()`` function:
1414

1515
.. code-block:: javascript
1616
@@ -21,7 +21,7 @@ application: it will *require* all of the dependencies it needs (e.g. jQuery or
2121
2222
// var $ = require('jquery');
2323
24-
Encore's job (via Webpack) is simple: to read and follow *all* of the ``require``
24+
Encore's job (via Webpack) is simple: to read and follow *all* of the ``require()``
2525
statements and create one final ``app.js`` (and ``app.css``) that contains *everything*
2626
your app needs. Encore can do a lot more: minify files, pre-process Sass/LESS,
2727
support React, Vue.js, etc.
@@ -51,7 +51,7 @@ of your project. It already holds the basic config you need:
5151
// ...
5252
5353
They *key* part is ``addEntry()``: this tells Encore to load the ``assets/js/app.js``
54-
file and follow *all* of the ``require`` statements. It will then package everything
54+
file and follow *all* of the ``require()`` statements. It will then package everything
5555
together and - thanks to the first ``app`` argument - output final ``app.js`` and
5656
``app.css`` files into the ``public/build`` directory.
5757

@@ -120,7 +120,7 @@ be executed. All the CSS files that were required will also be displayed.
120120

121121
The ``encore_entry_link_tags()`` and ``encore_entry_script_tags()`` functions
122122
read from an ``entrypoints.json`` file that's generated by Encore to know the exact
123-
filename(s) to render . This file is *especially* useful because you can
123+
filename(s) to render. This file is *especially* useful because you can
124124
:doc:`enable versioning</frontend/encore/versioning>` or
125125
:doc:`point assets to a CDN</frontend/encore/cdn>` without making *any* changes to your
126126
template: the paths in ``entrypoints.json`` will always be the final, correct paths.
@@ -179,11 +179,11 @@ added to the output file (``app.js``). Refresh to see the message!
179179
The import and export Statements
180180
--------------------------------
181181

182-
Instead of using ``require`` and ``module.exports`` like shown above, JavaScript
182+
Instead of using ``require()`` and ``module.exports`` like shown above, JavaScript
183183
provides an alternate syntax based on the `ECMAScript 6 modules`_ that includes
184184
the ability to use dynamic imports.
185185

186-
To export values using the alternate syntax, use ``exports``:
186+
To export values using the alternate syntax, use ``export``:
187187

188188
.. code-block:: diff
189189
@@ -343,7 +343,7 @@ This will output a new ``some_page.css``.
343343
Keep Going!
344344
-----------
345345

346-
Encore support many more features! For a full list of what you can do, see
346+
Encore supports many more features! For a full list of what you can do, see
347347
`Encore's index.js file`_. Or, go back to :ref:`list of Encore articles <encore-toc>`.
348348

349349
.. _`Encore's index.js file`: https://github.com/symfony/webpack-encore/blob/master/index.js

http_cache/expiration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ HTTP headers: ``Expires`` or ``Cache-Control``.
2121
Expiration with the ``Cache-Control`` Header
2222
--------------------------------------------
2323

24-
Most of the time, you will use the ``Cache-Control`` header. Recall that the
25-
``Cache-Control`` header is used to specify many different cache directives::
24+
Most of the time, you will use the ``Cache-Control`` header, which
25+
is used to specify many different cache directives::
2626

2727
// sets the number of seconds after which the response
2828
// should no longer be considered fresh by shared caches

messenger.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1343,6 +1343,10 @@ middleware and *only* include your own:
13431343
Middleware for Doctrine
13441344
~~~~~~~~~~~~~~~~~~~~~~~
13451345

1346+
.. versionadded:: 1.11
1347+
1348+
The following Doctrine middleware were introduced in DoctrineBundle 1.11.
1349+
13461350
If you use Doctrine in your app, a number of optional middleware exist that you
13471351
may want to use:
13481352

templates.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -897,7 +897,7 @@ template, such as ``blog/index.html.twig``, which displays the blog index:
897897

898898
This template extends from the second-level template (``blog/layout.html.twig``)
899899
but overrides blocks of different parent templates: ``content`` from
900-
``blog/index.html.twig`` and ``title`` from ``base.html.twig``.
900+
``blog/layout.html.twig`` and ``title`` from ``base.html.twig``.
901901

902902
When you render the ``blog/index.html.twig`` template, Symfony uses three
903903
different templates to create the final contents. This inheritance mechanism

workflow.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ like this:
127127
],
128128
'marking_store' => [
129129
'type' => 'method'
130-
'property' => ['currentPlace']
130+
'property' => 'currentPlace'
131131
],
132132
'supports' => ['App\Entity\BlogPost'],
133133
'initial_marking' => 'draft',

0 commit comments

Comments
 (0)
0