Fixed (mostly) yaml code blocks

Initial idea was to fix the highlighting. While doing that, others things also got a fix: * indenting * missing formats * some `...` in XML elements * missing comments in other formats
symfony · Jan 21, 2014 · 7c0cf89 · 7c0cf89
1 parent 2a43a97
commit 7c0cf89
Show file tree

Hide file tree

Showing 36 changed files with 168 additions and 122 deletions.
diff --git a/components/config/definition.rst b/components/config/definition.rst
@@ -21,14 +21,14 @@ applied to it (like: "the value for ``auto_connect`` must be a boolean value"):
     default_connection: mysql
     connections:
         mysql:
-            host: localhost
-            driver: mysql
+            host:     localhost
+            driver:   mysql
             username: user
             password: pass
         sqlite:
-            host: localhost
-            driver: sqlite
-            memory: true
+            host:     localhost
+            driver:   sqlite
+            memory:   true
             username: user
             password: pass
 
@@ -473,9 +473,9 @@ in this config:
 .. code-block:: yaml
 
     connection:
-        name: my_mysql_connection
-        host: localhost
-        driver: mysql
+        name:     my_mysql_connection
+        host:     localhost
+        driver:   mysql
         username: user
         password: pass
 

diff --git a/components/dependency_injection/parameters.rst b/components/dependency_injection/parameters.rst
@@ -134,8 +134,8 @@ making the class of a service a parameter:
 
         services:
             mailer:
-                class:     '%mailer.class%'
-                arguments: ['%mailer.transport%']
+                class:     "%mailer.class%"
+                arguments: ["%mailer.transport%"]
 
     .. code-block:: xml
 

diff --git a/components/dependency_injection/parentservices.rst b/components/dependency_injection/parentservices.rst
@@ -62,7 +62,7 @@ The service config for these classes would look something like this:
             my_email_formatter:
                 # ...
             newsletter_manager:
-                class:     "%newsletter_manager.class%"
+                class: "%newsletter_manager.class%"
                 calls:
                     - [setMailer, ["@my_mailer"]]
                     - [setEmailFormatter, ["@my_email_formatter"]]
@@ -196,7 +196,7 @@ a parent for a service.
                     - [setEmailFormatter, ["@my_email_formatter"]]
 
             newsletter_manager:
-                class:     "%newsletter_manager.class%"
+                class:  "%newsletter_manager.class%"
                 parent: mail_manager
 
             greeting_card_manager:
@@ -321,13 +321,13 @@ to the ``NewsletterManager`` class, the config would look like this:
                     - [setEmailFormatter, ["@my_email_formatter"]]
 
             newsletter_manager:
-                class:     "%newsletter_manager.class%"
+                class:  "%newsletter_manager.class%"
                 parent: mail_manager
                 calls:
                     - [setMailer, ["@my_alternative_mailer"]]
 
             greeting_card_manager:
-                class:     "%greeting_card_manager.class%"
+                class:  "%greeting_card_manager.class%"
                 parent: mail_manager
 
     .. code-block:: xml

diff --git a/components/dependency_injection/types.rst b/components/dependency_injection/types.rst
@@ -184,7 +184,7 @@ Another possibility is just setting public fields of the class directly::
             my_mailer:
                 # ...
             newsletter_manager:
-                class:     NewsletterManager
+                class: NewsletterManager
                 properties:
                     mailer: "@my_mailer"
 

diff --git a/cookbook/assetic/apply_to_option.rst b/cookbook/assetic/apply_to_option.rst
@@ -20,9 +20,9 @@ An example configuration might look like this:
         assetic:
             filters:
                 coffee:
-                    bin: /usr/bin/coffee
-                    node: /usr/bin/node
-                    node_paths: [ /usr/lib/node_modules/ ]
+                    bin:        /usr/bin/coffee
+                    node:       /usr/bin/node
+                    node_paths: [/usr/lib/node_modules/]
 
     .. code-block:: xml
 
@@ -130,10 +130,10 @@ applied to all ``.coffee`` files:
         assetic:
             filters:
                 coffee:
-                    bin: /usr/bin/coffee
-                    node: /usr/bin/node
-                    node_paths: [ /usr/lib/node_modules/ ]
-                    apply_to: "\.coffee$"
+                    bin:        /usr/bin/coffee
+                    node:       /usr/bin/node
+                    node_paths: [/usr/lib/node_modules/]
+                    apply_to:   "\.coffee$"
 
     .. code-block:: xml
 

diff --git a/cookbook/assetic/uglifyjs.rst b/cookbook/assetic/uglifyjs.rst
@@ -75,6 +75,7 @@ your JavaScripts:
 
         <!-- app/config/config.xml -->
         <assetic:config>
+            <!-- bin: the path to the uglifyjs executable -->
             <assetic:filter
                 name="uglifyjs2"
                 bin="/usr/local/bin/uglifyjs" />
@@ -86,6 +87,7 @@ your JavaScripts:
         $container->loadFromExtension('assetic', array(
             'filters' => array(
                 'uglifyjs2' => array(
+                    // the path to the uglifyjs executable
                     'bin' => '/usr/local/bin/uglifyjs',
                 ),
             ),

diff --git a/cookbook/bundles/override.rst b/cookbook/bundles/override.rst
@@ -53,7 +53,7 @@ in the core FrameworkBundle:
 
         # app/config/config.yml
         parameters:
-            translator.class:      Acme\HelloBundle\Translation\Translator
+            translator.class: Acme\HelloBundle\Translation\Translator
 
     .. code-block:: xml
 

diff --git a/cookbook/bundles/prepend_extension.rst b/cookbook/bundles/prepend_extension.rst
@@ -99,7 +99,6 @@ for ``acme_hello`` is set to ``non_default``:
     .. code-block:: yaml
 
         # app/config/config.yml
-
         acme_something:
             # ...
             use_acme_goodbye: false
@@ -112,7 +111,6 @@ for ``acme_hello`` is set to ``non_default``:
     .. code-block:: xml
 
         <!-- app/config/config.xml -->
-
         <acme-something:config use-acme-goodbye="false">
             <acme-something:entity-manager-name>non_default</acme-something:entity-manager-name>
         </acme-something:config>
@@ -122,7 +120,6 @@ for ``acme_hello`` is set to ``non_default``:
     .. code-block:: php
 
         // app/config/config.php
-
         $container->loadFromExtension('acme_something', array(
             ...,
             'use_acme_goodbye' => false,

diff --git a/cookbook/configuration/apache_router.rst b/cookbook/configuration/apache_router.rst
@@ -60,7 +60,7 @@ To test that it's working, let's create a very basic route for the AcmeDemoBundl
 
         # app/config/routing.yml
         hello:
-            path:  /hello/{name}
+            path: /hello/{name}
             defaults: { _controller: AcmeDemoBundle:Demo:hello }
 
     .. code-block:: xml

diff --git a/cookbook/configuration/environments.rst b/cookbook/configuration/environments.rst
@@ -64,18 +64,21 @@ easily and transparently:
 
         imports:
             - { resource: config.yml }
+
         # ...
 
     .. code-block:: xml
 
         <imports>
             <import resource="config.xml" />
         </imports>
+
         <!-- ... -->
 
     .. code-block:: php
 
         $loader->import('config.php');
+
         // ...
 
 To share common configuration, each environment's configuration file
@@ -188,12 +191,12 @@ environment by using this code and changing the environment string.
 
             doctrine:
                dbal:
-                   logging:  "%kernel.debug%"
+                   logging: "%kernel.debug%"
                    # ...
 
         .. code-block:: xml
 
-            <doctrine:dbal logging="%kernel.debug%" ... />
+            <doctrine:dbal logging="%kernel.debug%" />
 
         .. code-block:: php
 

diff --git a/cookbook/configuration/pdo_session_storage.rst b/cookbook/configuration/pdo_session_storage.rst
@@ -29,7 +29,7 @@ configuration format of your choice):
         framework:
             session:
                 # ...
-                handler_id:     session.handler.pdo
+                handler_id: session.handler.pdo
 
         parameters:
             pdo.db_options:

diff --git a/cookbook/controller/service.rst b/cookbook/controller/service.rst
@@ -60,7 +60,7 @@ Then you can define it as a service as follows:
 
         services:
             acme.hello.controller:
-                class:     "%acme.controller.hello.class%"
+                class: "%acme.controller.hello.class%"
 
     .. code-block:: xml
 
@@ -112,8 +112,8 @@ the route ``_controller`` value:
 
         # app/config/routing.yml
         hello:
-            path:         /hello
-            defaults:     { _controller: acme.hello.controller:indexAction }
+            path:     /hello
+            defaults: { _controller: acme.hello.controller:indexAction }
 
     .. code-block:: xml
 

diff --git a/cookbook/doctrine/dbal.rst b/cookbook/doctrine/dbal.rst
@@ -92,7 +92,7 @@ mapping types, read Doctrine's `Custom Mapping Types`_ section of their document
         doctrine:
             dbal:
                 types:
-                    custom_first: Acme\HelloBundle\Type\CustomFirst
+                    custom_first:  Acme\HelloBundle\Type\CustomFirst
                     custom_second: Acme\HelloBundle\Type\CustomSecond
 
     .. code-block:: xml
@@ -143,7 +143,7 @@ mapping type:
             dbal:
                 connections:
                     default:
-                        // Other connections parameters
+                        # other connections parameters
                         mapping_types:
                             enum: string
 
@@ -160,6 +160,7 @@ mapping type:
                 <doctrine:dbal>
                 <doctrine:dbal default-connection="default">
                     <doctrine:connection>
+                        <!-- other connections parameters -->
                         <doctrine:mapping-type name="enum">string</doctrine:mapping-type>
                     </doctrine:connection>
                 </doctrine:dbal>
@@ -173,6 +174,7 @@ mapping type:
             'dbal' => array(
                 'connections' => array(
                     'default' => array(
+                        // other connection parameers
                         'mapping_types' => array(
                             'enum'  => 'string',
                         ),

diff --git a/cookbook/doctrine/multiple_entity_managers.rst b/cookbook/doctrine/multiple_entity_managers.rst
@@ -24,7 +24,7 @@ The following configuration code shows how you can configure two entity managers
 
         doctrine:
             dbal:
-                default_connection:   default
+                default_connection: default
                 connections:
                     default:
                         driver:   "%database_driver%"
@@ -44,22 +44,21 @@ The following configuration code shows how you can configure two entity managers
                         charset:  UTF8
 
             orm:
-                default_entity_manager:   default
+                default_entity_manager: default
                 entity_managers:
                     default:
-                        connection:       default
+                        connection: default
                         mappings:
-                            AcmeDemoBundle: ~
+                            AcmeDemoBundle:  ~
                             AcmeStoreBundle: ~
                     customer:
-                        connection:       customer
+                        connection: customer
                         mappings:
                             AcmeCustomerBundle: ~
 
     .. code-block:: xml
 
         <?xml version="1.0" encoding="UTF-8"?>
-
         <srv:container xmlns="http://symfony.com/schema/dic/doctrine"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xmlns:srv="http://symfony.com/schema/dic/services"

diff --git a/cookbook/doctrine/resolve_target_entity.rst b/cookbook/doctrine/resolve_target_entity.rst
@@ -114,9 +114,9 @@ about the replacement:
 
         # app/config/config.yml
         doctrine:
-            # ....
+            # ...
             orm:
-                # ....
+                # ...
                 resolve_target_entities:
                     Acme\InvoiceBundle\Model\InvoiceSubjectInterface: Acme\AppBundle\Entity\Customer
 

diff --git a/cookbook/email/dev_environment.rst b/cookbook/email/dev_environment.rst
@@ -65,7 +65,7 @@ via the ``delivery_address`` option:
 
         # app/config/config_dev.yml
         swiftmailer:
-            delivery_address:  dev@example.com
+            delivery_address: dev@example.com
 
     .. code-block:: xml
 
@@ -76,8 +76,7 @@ via the ``delivery_address`` option:
             http://symfony.com/schema/dic/swiftmailer http://symfony.com/schema/dic/swiftmailer/swiftmailer-1.0.xsd
         -->
 
-        <swiftmailer:config
-            delivery-address="dev@example.com" />
+        <swiftmailer:config delivery-address="dev@example.com" />
 
     .. code-block:: php
 

diff --git a/cookbook/email/gmail.rst b/cookbook/email/gmail.rst
@@ -59,7 +59,7 @@ You're done!
 
         # app/config/parameters.yml
         parameters:
-            ...
+            # ...
             mailer_transport: gmail
             mailer_host:      ~
             mailer_user:      your_gmail_username

diff --git a/cookbook/form/dynamic_form_modification.rst b/cookbook/form/dynamic_form_modification.rst
@@ -407,9 +407,7 @@ it with :ref:`dic-tags-form-type`.
                 class: Acme\DemoBundle\Form\Type\FriendMessageFormType
                 arguments: ["@security.context"]
                 tags:
-                    -
-                        name: form.type
-                        alias: acme_friend_message
+                    - { name: form.type, alias: acme_friend_message }
 
     .. code-block:: xml