Update contributing/code/standards.rst

Maik Penz · weaverryan · commit 6ced7222dc64 · 2012-11-25T20:22:55.000-05:00
Included suggestions by WouterJ. @param and @return should be separated by a single blank line (SF 2). Demonstration of trailing `,` for arrays should have a higher priority than the otherwise recommended single-line array notation (`array('key' => 'value')` in favour of `array('key' => 'value', )`). Multi-line function call syntax as suggested for SF2 is not PSR-2 conform. It may be required to consider more examples or discuss that rule at a higher level.
diff --git a/contributing/code/standards.rst b/contributing/code/standards.rst
@@ -18,7 +18,7 @@ example containing most features described below:
 .. code-block:: php
 
     <?php
-    
+
     /*
      * This file is part of the Symfony package.
      *
@@ -27,38 +27,41 @@ example containing most features described below:
      * For the full copyright and license information, please view the LICENSE
      * file that was distributed with this source code.
      */
-    
+
     namespace Acme;
-    
+
     /**
-     * FooBar class.
-     *
+     * Coding standards demonstration.
      */
     class FooBar
     {
         const SOME_CONST = 42;
-    
+
         private $fooBar;
-    
+
         /**
          * @param string $dummy Some argument description
          */
         public function __construct($dummy)
         {
             $this->fooBar = $this->transformText($dummy);
         }
-    
+
         /**
          * @param string $dummy Some argument description
+         *
          * @return string|null Transformed input
          */
         private function transformText($dummy, $options = array())
         {
             $mergedOptions = array_merge(
                 $options,
-                array('some_default' => 'values', )
+                array(
+                    'some_default' => 'values',
+                    'another_default' => 'more values',
+                )
             );
-    
+
             if (true === $dummy) {
                 return;
             }
@@ -69,7 +72,7 @@ example containing most features described below:
                     $dummy = ucwords($dummy);
                 }
             }
-    
+
             return $dummy;
         }
     }
