Merge branch '3.4' into 4.3

javiereguiluz · javiereguiluz · commit 1146cd98fc12 · 2019-10-29T10:26:04.000+01:00
* 3.4:
  Add parentheses after require() function name
  Fixes a typo in expiration.rst
  Remove assumption about why people read the documentation
  Fix a few misprints
diff --git a/contributing/documentation/standards.rst b/contributing/documentation/standards.rst
@@ -173,11 +173,10 @@ In addition, documentation follows these rules:
   * his or hers, use theirs
   * himself or herself, use themselves
 
-* **Avoid belittling words**: People read documentation because they know very
-  little about a specific topic or are even completely new to it. Things that
-  seem "obvious" or "simple" for the person documenting it, can be the exact
-  opposite for the reader. To make sure everybody feels comfortable when reading
-  the documentation, try to avoid words like:
+* **Avoid belittling words**: Things that seem "obvious" or "simple" for the
+  person documenting it, can be the exact opposite for the reader. To make sure
+  everybody feels comfortable when reading the documentation, try to avoid words
+  like:
 
   * basically
   * clearly
diff --git a/frontend/encore/simple-example.rst b/frontend/encore/simple-example.rst
@@ -10,7 +10,7 @@ CSS and one JS file, organized into an ``assets/`` directory:
 With Encore, think of your ``app.js`` file like a standalone JavaScript
 application: it will *require* all of the dependencies it needs (e.g. jQuery or React),
 *including* any CSS. Your ``app.js`` file is already doing this with a special
-``require`` function:
+``require()`` function:
 
 .. code-block:: javascript
 
@@ -21,7 +21,7 @@ application: it will *require* all of the dependencies it needs (e.g. jQuery or
 
     // var $ = require('jquery');
 
-Encore's job (via Webpack) is simple: to read and follow *all* of the ``require``
+Encore's job (via Webpack) is simple: to read and follow *all* of the ``require()``
 statements and create one final ``app.js`` (and ``app.css``) that contains *everything*
 your app needs. Encore can do a lot more: minify files, pre-process Sass/LESS,
 support React, Vue.js, etc.
@@ -51,7 +51,7 @@ of your project. It already holds the basic config you need:
     // ...
 
 They *key* part is ``addEntry()``: this tells Encore to load the ``assets/js/app.js``
-file and follow *all* of the ``require`` statements. It will then package everything
+file and follow *all* of the ``require()`` statements. It will then package everything
 together and - thanks to the first ``app`` argument - output final ``app.js`` and
 ``app.css`` files into the ``public/build`` directory.
 
@@ -120,7 +120,7 @@ be executed. All the CSS files that were required will also be displayed.
 
 The ``encore_entry_link_tags()`` and ``encore_entry_script_tags()`` functions
 read from an ``entrypoints.json`` file that's generated by Encore to know the exact
-filename(s) to render . This file is *especially* useful because you can
+filename(s) to render. This file is *especially* useful because you can
 :doc:`enable versioning</frontend/encore/versioning>` or
 :doc:`point assets to a CDN</frontend/encore/cdn>` without making *any* changes to your
 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!
 The import and export Statements
 --------------------------------
 
-Instead of using ``require`` and ``module.exports`` like shown above, JavaScript
+Instead of using ``require()`` and ``module.exports`` like shown above, JavaScript
 provides an alternate syntax based on the `ECMAScript 6 modules`_ that includes
 the ability to use dynamic imports.
 
-To export values using the alternate syntax, use ``exports``:
+To export values using the alternate syntax, use ``export``:
 
 .. code-block:: diff
 
@@ -343,7 +343,7 @@ This will output a new ``some_page.css``.
 Keep Going!
 -----------
 
-Encore support many more features! For a full list of what you can do, see
+Encore supports many more features! For a full list of what you can do, see
 `Encore's index.js file`_. Or, go back to :ref:`list of Encore articles <encore-toc>`.
 
 .. _`Encore's index.js file`: https://github.com/symfony/webpack-encore/blob/master/index.js
diff --git a/http_cache/expiration.rst b/http_cache/expiration.rst
@@ -21,8 +21,8 @@ HTTP headers: ``Expires`` or ``Cache-Control``.
 Expiration with the ``Cache-Control`` Header
 --------------------------------------------
 
-Most of the time, you will use the ``Cache-Control`` header. Recall that the
-``Cache-Control`` header is used to specify many different cache directives::
+Most of the time, you will use the ``Cache-Control`` header, which
+is used to specify many different cache directives::
 
     // sets the number of seconds after which the response
     // should no longer be considered fresh by shared caches
