symfony · OskarStark · Mar 22, 2019 · xabbuh · Mar 22, 2019
diff --git a/best_practices/security.rst b/best_practices/security.rst
@@ -1,7 +1,7 @@
 Security
 ========

-Authentication and Firewalls (i.e. Getting the User's Credentials)
+Authentication and Firewalls (e.g. Getting the User's Credentials)
 ------------------------------------------------------------------

 You can configure Symfony to authenticate your users using any method you
@@ -77,7 +77,7 @@ which uses a login form to load users from the database:

    The source code for our project contains comments that explain each part.

-Authorization (i.e. Denying Access)
+Authorization (e.g. Denying Access)
 -----------------------------------

 Symfony gives you several ways to enforce authorization, including the ``access_control``

diff --git a/bundles/best_practices.rst b/bundles/best_practices.rst
@@ -37,7 +37,7 @@ A namespace becomes a bundle as soon as you add a bundle class to it. The
 bundle class name must follow these simple rules:

 * Use only alphanumeric characters and underscores;
-* Use a StudlyCaps name (i.e. camelCase with the first letter uppercased);
+* Use a StudlyCaps name (e.g. camelCase with the first letter uppercased);
 * Use a descriptive and short name (no more than two words);
 * Prefix the name with the concatenation of the vendor (and optionally the
  category namespaces);

diff --git a/bundles/extension.rst b/bundles/extension.rst
@@ -116,7 +116,7 @@ Other available loaders are the ``YamlFileLoader``, ``PhpFileLoader`` and

 .. caution::

-    If you removed the default file with service definitions (i.e.
+    If you removed the default file with service definitions (e.g.
    ``app/config/services.yml``), make sure to also remove it from the
    ``imports`` key in ``app/config/config.yml``.


diff --git a/components/cache/adapters/apcu_adapter.rst b/components/cache/adapters/apcu_adapter.rst
@@ -27,7 +27,7 @@ and cache items version string as constructor arguments::
        $namespace = '',

        // the default lifetime (in seconds) for cache items that do not define their
-        // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
+        // own lifetime, with a value 0 causing items to be stored indefinitely (e.g.
        // until the APCu memory is cleared)
        $defaultLifetime = 0,


diff --git a/components/cache/adapters/array_cache_adapter.rst b/components/cache/adapters/array_cache_adapter.rst
@@ -18,7 +18,7 @@ toggles serialization as its second parameter::
    $cache = new ArrayAdapter(

        // the default lifetime (in seconds) for cache items that do not define their
-        // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
+        // own lifetime, with a value 0 causing items to be stored indefinitely (e.g.
        // until the current PHP process finishes)
        $defaultLifetime = 0,


diff --git a/components/cache/adapters/doctrine_adapter.rst b/components/cache/adapters/doctrine_adapter.rst
@@ -29,7 +29,7 @@ third parameters::
        $namespace = '',

        // the default lifetime (in seconds) for cache items that do not define their
-        // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
+        // own lifetime, with a value 0 causing items to be stored indefinitely (e.g.
        // until the database table is truncated or its rows are otherwise deleted)
        $defaultLifetime = 0
    );

diff --git a/components/cache/adapters/filesystem_adapter.rst b/components/cache/adapters/filesystem_adapter.rst
@@ -30,7 +30,7 @@ and cache root path as constructor parameters::
        $namespace = '',

        // the default lifetime (in seconds) for cache items that do not define their
-        // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
+        // own lifetime, with a value 0 causing items to be stored indefinitely (e.g.
        // until the files are deleted)
        $defaultLifetime = 0,


diff --git a/components/cache/adapters/memcached_adapter.rst b/components/cache/adapters/memcached_adapter.rst
@@ -38,7 +38,7 @@ the second and third parameters::
        $namespace = '',

        // the default lifetime (in seconds) for cache items that do not define their
-        // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
+        // own lifetime, with a value 0 causing items to be stored indefinitely (e.g.
        // until MemcachedAdapter::clear() is invoked or the server(s) are restarted)
        $defaultLifetime = 0
    );

diff --git a/components/cache/adapters/pdo_doctrine_dbal_adapter.rst b/components/cache/adapters/pdo_doctrine_dbal_adapter.rst
@@ -27,7 +27,7 @@ third, and forth parameters::
        $namespace = '',

        // the default lifetime (in seconds) for cache items that do not define their
-        // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
+        // own lifetime, with a value 0 causing items to be stored indefinitely (e.g.
        // until the database table is truncated or its rows are otherwise deleted)
        $defaultLifetime = 0,


diff --git a/components/cache/adapters/php_files_adapter.rst b/components/cache/adapters/php_files_adapter.rst
@@ -51,7 +51,7 @@ directory path as constructor arguments::
        $namespace = '',

        // the default lifetime (in seconds) for cache items that do not define their
-        // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
+        // own lifetime, with a value 0 causing items to be stored indefinitely (e.g.
        // until the files are deleted)
        $defaultLifetime = 0,


diff --git a/components/cache/adapters/proxy_adapter.rst b/components/cache/adapters/proxy_adapter.rst
@@ -27,7 +27,7 @@ and optionally a namespace and default cache lifetime as its second and third pa
        $namespace = '',

        // the default lifetime (in seconds) for cache items that do not define their
-        // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
+        // own lifetime, with a value 0 causing items to be stored indefinitely (e.g.
        // until the cache is cleared)
        $defaultLifetime = 0
    );

diff --git a/components/cache/adapters/redis_adapter.rst b/components/cache/adapters/redis_adapter.rst
@@ -34,7 +34,7 @@ as the second and third parameters::
        $namespace = '',

        // the default lifetime (in seconds) for cache items that do not define their
-        // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
+        // own lifetime, with a value 0 causing items to be stored indefinitely (e.g.
        // until RedisAdapter::clear() is invoked or the server(s) are purged)
        $defaultLifetime = 0
    );

diff --git a/components/config/definition.rst b/components/config/definition.rst
@@ -335,7 +335,7 @@ the Symfony Config component treats arrays as lists by default.
 .. note::

    As of writing this, there is an inconsistency: if only one file provides the
-    configuration in question, the keys (i.e. ``sf_connection`` and ``default``)
+    configuration in question, the keys (e.g. ``sf_connection`` and ``default``)
    are *not* lost. But if more than one file provides the configuration, the keys
    are lost as described above.


diff --git a/components/console/helpers/progressbar.rst b/components/console/helpers/progressbar.rst
@@ -37,7 +37,7 @@ number of units, and advance the progress as the command executes::

 .. tip::

-    You can also regress the progress bar (i.e. step backwards) by calling
+    You can also regress the progress bar (e.g. step backwards) by calling
    ``$progress->advance()`` with a negative value. For example, if you call
    ``$progress->advance(-2)`` then it will regress the progress bar 2 steps.


diff --git a/components/console/usage.rst b/components/console/usage.rst
@@ -153,7 +153,7 @@ can run it with:
    # php application.php de:Gr Fabien
    # php application.php DE:Gre Fabien

-If you enter a short command that's ambiguous (i.e. there are more than one
+If you enter a short command that's ambiguous (e.g. there are more than one
 command that match), then no command will be run and some suggestions of
 the possible commands to choose from will be output.


diff --git a/components/event_dispatcher.rst b/components/event_dispatcher.rst
@@ -42,7 +42,7 @@ event - ``kernel.response``. Here's how it works:
  the ``kernel.response`` event, passing with it an ``Event`` object that
  has access to the ``Response`` object;

-* The dispatcher notifies (i.e. calls a method on) all listeners of the
+* The dispatcher notifies (e.g. calls a method on) all listeners of the
  ``kernel.response`` event, allowing each of them to make modifications
  to the ``Response`` object.

@@ -405,7 +405,7 @@ Stopping Event Flow/Propagation
 In some cases, it may make sense for a listener to prevent any other listeners
 from being called. In other words, the listener needs to be able to tell
 the dispatcher to stop all propagation of the event to future listeners
-(i.e. to not notify any more listeners). This can be accomplished from
+(e.g. to not notify any more listeners). This can be accomplished from
 inside a listener via the
 :method:`Symfony\\Component\\EventDispatcher\\Event::stopPropagation` method::

@@ -460,7 +460,7 @@ specifically pass one::
    $dispatcher->dispatch('order.placed');

 Moreover, the event dispatcher always returns whichever event object that
-was dispatched, i.e. either the event that was passed or the event that
+was dispatched, e.g. either the event that was passed or the event that
 was created internally by the dispatcher. This allows for nice shortcuts::

    if (!$dispatcher->dispatch('foo.event')->isPropagationStopped()) {

diff --git a/components/finder.rst b/components/finder.rst
@@ -234,7 +234,7 @@ Restrict files and directories by path with the
    // for example this will match data/*.xml and data.xml if they exist
    $finder->path('data')->name('*.xml');

-On all platforms slash (i.e. ``/``) should be used as the directory separator.
+On all platforms slash (e.g. ``/``) should be used as the directory separator.

 The ``path()`` method accepts a string or a regular expression::


@@ -75,7 +75,7 @@ method::
    $form->handleRequest();

 Behind the scenes, this uses a :class:`Symfony\\Component\\Form\\NativeRequestHandler`
-object to read data off of the correct PHP superglobals (i.e. ``$_POST`` or
+object to read data off of the correct PHP superglobals (e.g. ``$_POST`` or
 ``$_GET``) based on the HTTP method configured on the form (POST is default).

 .. seealso::
@@ -231,7 +231,7 @@ always to add the :class:`Symfony\\Bridge\\Twig\\Extension\\FormExtension`
 to Twig, which gives you access to the Twig functions for rendering forms.
 To do this, you first need to create a :class:`Symfony\\Bridge\\Twig\\Form\\TwigRendererEngine`,
 where you define your :ref:`form themes <form-customization-form-themes>`
-(i.e. resources/files that define form HTML markup).
+(e.g. resources/files that define form HTML markup).

 For general details on rendering forms, see :doc:`/form/form_customization`.

@@ -649,7 +649,7 @@ method:

 This defines a common form "workflow", which contains 3 different possibilities:

-1) On the initial GET request (i.e. when the user "surfs" to your page),
+1) On the initial GET request (e.g. when the user "surfs" to your page),
   build your form and render it;

 If the request is a POST, process the submitted data (via ``handleRequest()``).

diff --git a/components/http_foundation/session_configuration.rst b/components/http_foundation/session_configuration.rst
@@ -132,7 +132,7 @@ Configuring Garbage Collection
 When a session opens, PHP will call the ``gc`` handler randomly according to the
 probability set by ``session.gc_probability`` / ``session.gc_divisor``. For
 example if these were set to ``5/100`` respectively, it would mean a probability
-of 5%. Similarly, ``3/4`` would mean a 3 in 4 chance of being called, i.e. 75%.
+of 5%. Similarly, ``3/4`` would mean a 3 in 4 chance of being called, e.g. 75%.

 If the garbage collection handler is invoked, PHP will pass the value stored in
 the ``php.ini`` directive ``session.gc_maxlifetime``. The meaning in this context is

diff --git a/components/http_kernel.rst b/components/http_kernel.rst
@@ -215,10 +215,10 @@ attributes).
 ~~~~~~~~~~~~~~~~~~~~~~~~~

 Assuming that no ``kernel.request`` listener was able to create a ``Response``,
-the next step in HttpKernel is to determine and prepare (i.e. resolve) the
+the next step in HttpKernel is to determine and prepare (e.g. resolve) the
 controller. The controller is the part of the end-application's code that
 is responsible for creating and returning the ``Response`` for a specific page.
-The only requirement is that it is a PHP callable - i.e. a function, method
+The only requirement is that it is a PHP callable - e.g. a function, method
 on an object or a ``Closure``.

 But *how* you determine the exact controller for a request is entirely up

diff --git a/components/process.rst b/components/process.rst
@@ -85,7 +85,7 @@ for new output before going to the next iteration::

 The ``mustRun()`` method is identical to ``run()``, except that it will throw
 a :class:`Symfony\\Component\\Process\\Exception\\ProcessFailedException`
-if the process couldn't be executed successfully (i.e. the process exited
+if the process couldn't be executed successfully (e.g. the process exited
 with a non-zero code)::

    use Symfony\Component\Process\Exception\ProcessFailedException;

diff --git a/components/security/authentication.rst b/components/security/authentication.rst
@@ -204,7 +204,7 @@ own, it just needs to follow these rules:
   :method:`Symfony\\Component\\Security\\Core\\Encoder\\PasswordEncoderInterface::encodePassword`
   and
   :method:`Symfony\\Component\\Security\\Core\\Encoder\\PasswordEncoderInterface::isPasswordValid`
-   must first of all make sure the password is not too long, i.e. the password length is no longer
+   must first of all make sure the password is not too long, e.g. the password length is no longer
   than 4096 characters. This is for security reasons (see `CVE-2013-5750`_), and you can use the
   :method:`Symfony\\Component\\Security\\Core\\Encoder\\BasePasswordEncoder::isPasswordTooLong`
   method for this check::
@@ -293,7 +293,7 @@ event is dispatched. But beware - this event will fire, for example, on *every*
 request if you have session-based authentication. See ``security.interactive_login``
 below if you need to do something when a user *actually* logs in.

-When a provider attempts authentication but fails (i.e. throws an ``AuthenticationException``),
+When a provider attempts authentication but fails (e.g. throws an ``AuthenticationException``),
 a ``security.authentication.failure`` event is dispatched. You could listen on
 the ``security.authentication.failure`` event, for example, in order to log
 failed login attempts.

diff --git a/components/security/authorization.rst b/components/security/authorization.rst
@@ -11,7 +11,7 @@ in the :class:`Symfony\\Component\\Security\\Core\\Authentication\\Token\\Storag
 using its :method:`Symfony\\Component\\Security\\Core\\Authentication\\Token\\Storage\\TokenStorageInterface::setToken`
 method.

-From then on, the user is authenticated, i.e. identified. Now, other parts
+From then on, the user is authenticated, e.g. identified. Now, other parts
 of the application can use the token to decide whether or not the user may
 request a certain URI, or modify a certain object. This decision will be made
 by an instance of :class:`Symfony\\Component\\Security\\Core\\Authorization\\AccessDecisionManagerInterface`.
@@ -88,7 +88,7 @@ manager to use them:
 ``vote(TokenInterface $token, $object, array $attributes)``
    this method will do the actual voting and return a value equal to one
    of the class constants of :class:`Symfony\\Component\\Security\\Core\\Authorization\\Voter\\VoterInterface`,
-    i.e. ``VoterInterface::ACCESS_GRANTED``, ``VoterInterface::ACCESS_DENIED``
+    e.g. ``VoterInterface::ACCESS_GRANTED``, ``VoterInterface::ACCESS_DENIED``
    or ``VoterInterface::ACCESS_ABSTAIN``;

 The Security component contains some standard voters which cover many use
@@ -100,7 +100,7 @@ AuthenticatedVoter
 The :class:`Symfony\\Component\\Security\\Core\\Authorization\\Voter\\AuthenticatedVoter`
 voter supports the attributes ``IS_AUTHENTICATED_FULLY``, ``IS_AUTHENTICATED_REMEMBERED``,
 and ``IS_AUTHENTICATED_ANONYMOUSLY`` and grants access based on the current
-level of authentication, i.e. is the user fully authenticated, or only based
+level of authentication, e.g. is the user fully authenticated, or only based
 on a "remember-me" cookie, or even authenticated anonymously?

 .. code-block:: php

diff --git a/components/security/firewall.rst b/components/security/firewall.rst
@@ -135,7 +135,7 @@ which will eventually result in an "HTTP/1.1 403: Access Denied" response.
 Entry Points
 ~~~~~~~~~~~~

-When the user is not authenticated at all (i.e. when the token storage
+When the user is not authenticated at all (e.g. when the token storage
 has no token yet), the firewall's entry point will be called to "start"
 the authentication process. An entry point should implement
 :class:`Symfony\\Component\\Security\\Http\\EntryPoint\\AuthenticationEntryPointInterface`,

diff --git a/components/translation/usage.rst b/components/translation/usage.rst
@@ -157,7 +157,7 @@ recommended format. These files are parsed by one of the loader classes.
    In the second method, messages are actually "keywords" that convey the
    idea of the message. The keyword message is then used as the "id" for
    any translations. In this case, translations must be made for the default
-    locale (i.e. to translate ``symfony.great`` to ``Symfony is great``).
+    locale (e.g. to translate ``symfony.great`` to ``Symfony is great``).

    The second method is handy because the message key won't need to be changed
    in every translation file if you decide that the message should actually

diff --git a/components/var_dumper/advanced.rst b/components/var_dumper/advanced.rst
@@ -394,13 +394,13 @@ can use:
 * :class:`Symfony\\Component\\VarDumper\\Caster\\ConstStub` to wrap a value that is
  best represented by a PHP constant;
 * :class:`Symfony\\Component\\VarDumper\\Caster\\ClassStub` to wrap a PHP identifier
-  (*i.e.* a class name, a method name, an interface, *etc.*);
+  (*e.g.* a class name, a method name, an interface, *etc.*);
 * :class:`Symfony\\Component\\VarDumper\\Caster\\CutStub` to replace big noisy
  objects/strings/*etc.* by ellipses;
 * :class:`Symfony\\Component\\VarDumper\\Caster\\CutArrayStub` to keep only some
  useful keys of an array;
 * :class:`Symfony\\Component\\VarDumper\\Caster\\EnumStub` to wrap a set of virtual
-  values (*i.e.* values that do not exist as properties in the original PHP data
+  values (*e.g.* values that do not exist as properties in the original PHP data
  structure, but are worth listing alongside with real ones);
 * :class:`Symfony\\Component\\VarDumper\\Caster\\LinkStub` to wrap strings that can
  be turned into links by dumpers;

diff --git a/components/workflow.rst b/components/workflow.rst
@@ -34,7 +34,7 @@ the action to get from one place to another.
 .. image:: /_images/components/workflow/states_transitions.png

 A set of places and transitions creates a **definition**. A workflow needs
-a ``Definition`` and a way to write the states to the objects (i.e. an
+a ``Definition`` and a way to write the states to the objects (e.g. an
 instance of a :class:`Symfony\\Component\\Workflow\\MarkingStore\\MarkingStoreInterface`).

 Consider the following example for a blog post. A post can have one of a number

diff --git a/configuration.rst b/configuration.rst
@@ -91,7 +91,7 @@ The main configuration file is called ``config.yml``:
        // ...

 Most top-level keys - like ``framework`` and ``twig`` - are configuration for a
-specific bundle (i.e. ``FrameworkBundle`` and ``TwigBundle``).
+specific bundle (e.g. ``FrameworkBundle`` and ``TwigBundle``).

 .. sidebar:: Configuration Formats


diff --git a/configuration/override_dir_structure.rst b/configuration/override_dir_structure.rst
@@ -53,7 +53,7 @@ in the ``AppKernel`` class of your application::
        }
    }

-In this code, ``$this->environment`` is the current environment (i.e. ``dev``).
+In this code, ``$this->environment`` is the current environment (e.g. ``dev``).
 In this case you have changed the location of the cache directory to
 ``var/{environment}/cache``.


diff --git a/contributing/code_of_conduct/reporting_guidelines.rst b/contributing/code_of_conduct/reporting_guidelines.rst
@@ -53,7 +53,7 @@ to how to respond. Responses may include:
 * Nothing (if we determine no Code of Conduct violation occurred).
 * A private reprimand from the Code of Conduct response team to the individual(s)
  involved.
-* An imposed vacation (i.e. asking someone to "take a week off" from a mailing
+* An imposed vacation (e.g. asking someone to "take a week off" from a mailing
  list or Slack).
 * A permanent or temporary ban from some or all Symfony conference/community
  spaces (events, meetings, mailing lists, IRC, Slack, etc.)

diff --git a/contributing/documentation/standards.rst b/contributing/documentation/standards.rst
@@ -164,7 +164,7 @@ In addition, documentation follows these rules:

 * **Punctuation**: avoid the use of `Serial (Oxford) Commas`_;
 * **Pronouns**: avoid the use of `nosism`_ and always use *you* instead of *we*.
-  (i.e. avoid the first person point of view: use the second instead);
+  (e.g. avoid the first person point of view: use the second instead);
 * **Gender-neutral language**: when referencing a hypothetical person, such as
  *"a user with a session cookie"*, use gender-neutral pronouns (they/their/them).
  For example, instead of:

diff --git a/controller.rst b/controller.rst
@@ -426,7 +426,7 @@ HTTP status code::
    throw new \Exception('Something went wrong!');

 In every case, an error page is shown to the end user and a full debug
-error page is shown to the developer (i.e. when you're using the ``app_dev.php``
+error page is shown to the developer (e.g. when you're using the ``app_dev.php``
 front controller - see :ref:`page-creation-environments`).

 You'll want to customize the error page your user sees. To do that, see

diff --git a/controller/soap_web_service.rst b/controller/soap_web_service.rst
@@ -19,7 +19,7 @@ create one from scratch or use a 3rd party generator.
    be applicable to other implementations.

 SOAP works by exposing the methods of a PHP object to an external entity
-(i.e. the person using the SOAP service). To start, create a class - ``HelloService`` -
+(e.g. the person using the SOAP service). To start, create a class - ``HelloService`` -
 which represents the functionality that you'll expose in your SOAP service.
 In this case, the SOAP service will allow the client to call a method called
 ``hello``, which happens to send an email::
-Original file line number
+Diff line change
@@ -1,7 +1,7 @@
     Security
     ========
-    Authentication and Firewalls (i.e. Getting the User's Credentials)
+    Authentication and Firewalls (e.g. Getting the User's Credentials)
             Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            xabbuh
  

      

      

      


        Mar 22, 2019


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      I think we need to be careful and not blindly replace all occurrences of "i.e." with "e.g." as they have different meanings. "e.g." is kind of equivalent to "for example" which is probably not meant here.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
            OskarStark reacted with thumbs up emoji
      
        
            
    All reactions
  


          
              
                👍
                  1 reaction
     ------------------------------------------------------------------
     You can configure Symfony to authenticate your users using any method you
@@ -77,7 +77,7 @@ which uses a login form to load users from the database:
         The source code for our project contains comments that explain each part.
-    Authorization (i.e. Denying Access)
+    Authorization (e.g. Denying Access)
     -----------------------------------
     Symfony gives you several ways to enforce authorization, including the ``access_control``
-          Expand Down