minor #4462 [Reference] Fixed lots of minor things using the review bot (WouterJ)

weaverryan · weaverryan · commit 5db83862999b · 2014-11-24T10:19:35.000-05:00
This PR was merged into the 2.3 branch. Discussion ---------- [Reference] Fixed lots of minor things using the review bot I started working on our review bot. While doing that, I was using some documents that didn't change a lot. I decided it was usefull to have these things fixed in the docs itself :) All are very minor, basic, review things. | Q | A | --- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | - Commits ------- 9befcaf Fixed wrong indentation a2c626f Bot fixes
diff --git a/reference/configuration/assetic.rst b/reference/configuration/assetic.rst
@@ -4,8 +4,8 @@
 AsseticBundle Configuration ("assetic")
 =======================================
 
-Full default Configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+Full Default Configuration
+--------------------------
 
 .. configuration-block::
 
diff --git a/reference/configuration/doctrine.rst b/reference/configuration/doctrine.rst
@@ -5,7 +5,7 @@
 DoctrineBundle Configuration ("doctrine")
 =========================================
 
-Full default configuration
+Full Default Configuration
 --------------------------
 
 .. configuration-block::
@@ -180,8 +180,10 @@ Full default configuration
         <container xmlns="http://symfony.com/schema/dic/services"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xmlns:doctrine="http://symfony.com/schema/dic/doctrine"
-            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
-                                http://symfony.com/schema/dic/doctrine http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                http://symfony.com/schema/dic/services/services-1.0.xsd
+                http://symfony.com/schema/dic/doctrine
+                http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">
 
             <doctrine:config>
                 <doctrine:dbal default-connection="default">
@@ -209,16 +211,44 @@ Full default configuration
                     <doctrine:type name="custom">Acme\HelloBundle\MyCustomType</doctrine:type>
                 </doctrine:dbal>
 
-                <doctrine:orm default-entity-manager="default" auto-generate-proxy-classes="false" proxy-namespace="Proxies" proxy-dir="%kernel.cache_dir%/doctrine/orm/Proxies">
-                    <doctrine:entity-manager name="default" query-cache-driver="array" result-cache-driver="array" connection="conn1" class-metadata-factory-name="Doctrine\ORM\Mapping\ClassMetadataFactory">
-                        <doctrine:metadata-cache-driver type="memcache" host="localhost" port="11211" instance-class="Memcache" class="Doctrine\Common\Cache\MemcacheCache" />
+                <doctrine:orm
+                    default-entity-manager="default"
+                    auto-generate-proxy-classes="false"
+                    proxy-namespace="Proxies"
+                    proxy-dir="%kernel.cache_dir%/doctrine/orm/Proxies"
+                >
+                    <doctrine:entity-manager
+                        name="default"
+                        query-cache-driver="array"
+                        result-cache-driver="array"
+                        connection="conn1"
+                        class-metadata-factory-name="Doctrine\ORM\Mapping\ClassMetadataFactory"
+                    >
+                        <doctrine:metadata-cache-driver
+                            type="memcache"
+                            host="localhost"
+                            port="11211"
+                            instance-class="Memcache"
+                            class="Doctrine\Common\Cache\MemcacheCache"
+                        />
+
                         <doctrine:mapping name="AcmeHelloBundle" />
+
                         <doctrine:dql>
-                            <doctrine:string-function name="test_string">Acme\HelloBundle\DQL\StringFunction</doctrine:string-function>
-                            <doctrine:numeric-function name="test_numeric">Acme\HelloBundle\DQL\NumericFunction</doctrine:numeric-function>
-                            <doctrine:datetime-function name="test_datetime">Acme\HelloBundle\DQL\DatetimeFunction</doctrine:datetime-function>
+                            <doctrine:string-function name="test_string">
+                                Acme\HelloBundle\DQL\StringFunction
+                            </doctrine:string-function>
+
+                            <doctrine:numeric-function name="test_numeric">
+                                Acme\HelloBundle\DQL\NumericFunction
+                            </doctrine:numeric-function>
+
+                            <doctrine:datetime-function name="test_datetime">
+                                Acme\HelloBundle\DQL\DatetimeFunction
+                            </doctrine:datetime-function>
                         </doctrine:dql>
                     </doctrine:entity-manager>
+
                     <doctrine:entity-manager name="em2" connection="conn2" metadata-cache-driver="apc">
                         <doctrine:mapping
                             name="DoctrineExtensions"
@@ -235,8 +265,8 @@ Full default configuration
 Configuration Overview
 ----------------------
 
-This following configuration example shows all the configuration defaults that
-the ORM resolves to:
+This following configuration example shows all the configuration defaults
+that the ORM resolves to:
 
 .. code-block:: yaml
 
@@ -258,8 +288,8 @@ certain classes, but those are for very advanced use-cases only.
 Caching Drivers
 ~~~~~~~~~~~~~~~
 
-For the caching drivers you can specify the values "array", "apc", "memcache", "memcached",
-"xcache" or "service".
+For the caching drivers you can specify the values "array", "apc", "memcache",
+"memcached", "xcache" or "service".
 
 The following example shows an overview of the caching configurations:
 
@@ -282,34 +312,34 @@ Mapping Configuration
 ~~~~~~~~~~~~~~~~~~~~~
 
 Explicit definition of all the mapped entities is the only necessary
-configuration for the ORM and there are several configuration options that you
-can control. The following configuration options exist for a mapping:
+configuration for the ORM and there are several configuration options that
+you can control. The following configuration options exist for a mapping:
 
 * ``type`` One of ``annotation``, ``xml``, ``yml``, ``php`` or ``staticphp``.
   This specifies which type of metadata type your mapping uses.
 
-* ``dir`` Path to the mapping or entity files (depending on the driver). If
-  this path is relative it is assumed to be relative to the bundle root. This
-  only works if the name of your mapping is a bundle name. If you want to use
-  this option to specify absolute paths you should prefix the path with the
-  kernel parameters that exist in the DIC (for example %kernel.root_dir%).
+* ``dir`` Path to the mapping or entity files (depending on the driver).
+  If this path is relative it is assumed to be relative to the bundle root.
+  This only works if the name of your mapping is a bundle name. If you want
+  to use this option to specify absolute paths you should prefix the path
+  with the kernel parameters that exist in the DIC (for example ``%kernel.root_dir%``).
 
 * ``prefix`` A common namespace prefix that all entities of this mapping
   share. This prefix should never conflict with prefixes of other defined
-  mappings otherwise some of your entities cannot be found by Doctrine. This
-  option defaults to the bundle namespace + ``Entity``, for example for an
-  application bundle called ``AcmeHelloBundle`` prefix would be
+  mappings otherwise some of your entities cannot be found by Doctrine.
+  This option defaults to the bundle namespace + ``Entity``, for example
+  for an application bundle called ``AcmeHelloBundle`` prefix would be
   ``Acme\HelloBundle\Entity``.
 
 * ``alias`` Doctrine offers a way to alias entity namespaces to simpler,
-  shorter names to be used in DQL queries or for Repository access. When using
-  a bundle the alias defaults to the bundle name.
+  shorter names to be used in DQL queries or for Repository access. When
+  using a bundle the alias defaults to the bundle name.
 
-* ``is_bundle`` This option is a derived value from ``dir`` and by default is
-  set to true if dir is relative proved by a ``file_exists()`` check that
-  returns false. It is false if the existence check returns true. In this case
-  an absolute path was specified and the metadata files are most likely in a
-  directory outside of a bundle.
+* ``is_bundle`` This option is a derived value from ``dir`` and by default
+  is set to true if dir is relative proved by a ``file_exists()`` check
+  that returns false. It is false if the existence check returns true. In
+  this case an absolute path was specified and the metadata files are most
+  likely in a directory outside of a bundle.
 
 .. index::
     single: Configuration; Doctrine DBAL
@@ -363,8 +393,11 @@ The following block shows all possible configuration keys:
         <container xmlns="http://symfony.com/schema/dic/services"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xmlns:doctrine="http://symfony.com/schema/dic/doctrine"
-            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
-                http://symfony.com/schema/dic/doctrine http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                http://symfony.com/schema/dic/services/services-1.0.xsd
+                http://symfony.com/schema/dic/doctrine
+                http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd"
+        >
 
             <doctrine:config>
                 <doctrine:dbal
diff --git a/reference/configuration/kernel.rst b/reference/configuration/kernel.rst
@@ -22,9 +22,9 @@ Charset
 
 **type**: ``string`` **default**: ``UTF-8``
 
-This returns the charset that is used in the application. To change it, override the
-:method:`Symfony\\Component\\HttpKernel\\Kernel::getCharset` method and return another
-charset, for instance::
+This returns the charset that is used in the application. To change it,
+override the :method:`Symfony\\Component\\HttpKernel\\Kernel::getCharset`
+method and return another charset, for instance::
 
     // app/AppKernel.php
 
@@ -40,12 +40,13 @@ charset, for instance::
 Kernel Name
 ~~~~~~~~~~~
 
-**type**: ``string`` **default**: ``app`` (i.e. the directory name holding the kernel class)
+**type**: ``string`` **default**: ``app`` (i.e. the directory name holding
+the kernel class)
 
 To change this setting, override the :method:`Symfony\\Component\\HttpKernel\\Kernel::getName`
-method. Alternatively, move your kernel into a different directory. For example,
-if you moved the kernel into a ``foo`` directory (instead of ``app``), the
-kernel name will be ``foo``.
+method. Alternatively, move your kernel into a different directory. For
+example, if you moved the kernel into a ``foo`` directory (instead of ``app``),
+the kernel name will be ``foo``.
 
 The name of the kernel isn't usually directly important - it's used in the
 generation of cache files. If you have an application with multiple kernels,
diff --git a/reference/configuration/monolog.rst b/reference/configuration/monolog.rst
@@ -4,7 +4,7 @@
 MonologBundle Configuration ("monolog")
 =======================================
 
-Full default Configuration
+Full Default Configuration
 --------------------------
 
 .. configuration-block::
@@ -67,8 +67,11 @@ Full default Configuration
         <container xmlns="http://symfony.com/schema/dic/services"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xmlns:monolog="http://symfony.com/schema/dic/monolog"
-            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
-                                http://symfony.com/schema/dic/monolog http://symfony.com/schema/dic/monolog/monolog-1.0.xsd">
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                http://symfony.com/schema/dic/services/services-1.0.xsd
+                http://symfony.com/schema/dic/monolog
+                http://symfony.com/schema/dic/monolog/monolog-1.0.xsd"
+        >
 
             <monolog:config>
                 <monolog:handler
diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst
@@ -253,8 +253,8 @@ The Login Form and Process
     ``use_forward`` is set to ``true``) when they try to access a
     protected resource but isn't fully authenticated.
 
-    This path **must** be accessible by a normal, un-authenticated user, else
-    you may create a redirect loop. For details, see
+    This path **must** be accessible by a normal, un-authenticated user,
+    else you may create a redirect loop. For details, see
     ":ref:`Avoid Common Pitfalls <book-security-common-pitfalls>`".
 
 *   ``check_path`` (type: ``string``, default: ``/login_check``)
@@ -266,8 +266,8 @@ The Login Form and Process
     a separate firewall just for ``check_path`` URL).
 
 *   ``use_forward`` (type: ``Boolean``, default: ``false``)
-    If you'd like the user to be forwarded to the login form instead of being
-    redirected, set this option to ``true``.
+    If you'd like the user to be forwarded to the login form instead of
+    being redirected, set this option to ``true``.
 
 *   ``username_parameter`` (type: ``string``, default: ``_username``)
     This is the field name that you should give to the username field of
