minor #8815 Follow the same code style in docblock annotations (vudaltsov)

wouterj · wouterj · commit e1d1dcd02252 · 2017-12-04T22:32:59.000+01:00
This PR was merged into the 2.7 branch. Discussion ---------- Follow the same code style in docblock annotations Commits ------- 6283116 Follow the same code style in docblock annotations
diff --git a/best_practices/business-logic.rst b/best_practices/business-logic.rst
@@ -257,7 +257,7 @@ looking for mapping information:
          *      mappedBy="post",
          *      orphanRemoval=true
          * )
-         * @ORM\OrderBy({"publishedAt" = "ASC"})
+         * @ORM\OrderBy({"publishedAt"="ASC"})
          */
         private $comments;
 
diff --git a/best_practices/controllers.rst b/best_practices/controllers.rst
@@ -166,7 +166,7 @@ manually. In our application, we have this situation in ``CommentController``:
 .. code-block:: php
 
     /**
-     * @Route("/comment/{postSlug}/new", name = "comment_new")
+     * @Route("/comment/{postSlug}/new", name="comment_new")
      */
     public function newAction(Request $request, $postSlug)
     {
@@ -192,8 +192,8 @@ flexible:
     use Symfony\Component\HttpFoundation\Request;
 
     /**
-     * @Route("/comment/{postSlug}/new", name = "comment_new")
-     * @ParamConverter("post", options={"mapping": {"postSlug": "slug"}})
+     * @Route("/comment/{postSlug}/new", name="comment_new")
+     * @ParamConverter("post", options={"mapping"={"postSlug"="slug"}})
      */
     public function newAction(Request $request, Post $post)
     {
diff --git a/reference/constraints/All.rst b/reference/constraints/All.rst
@@ -35,7 +35,7 @@ entry in that array:
             /**
              * @Assert\All({
              *     @Assert\NotBlank,
-             *     @Assert\Length(min = 5)
+             *     @Assert\Length(min=5)
              * })
              */
              protected $favoriteColors = array();
diff --git a/reference/constraints/Choice.rst b/reference/constraints/Choice.rst
@@ -52,7 +52,7 @@ If your valid choice list is simple, you can pass them in directly via the
             protected $city;
 
             /**
-             * @Assert\Choice(choices = {"fiction", "non-fiction"}, message = "Choose a valid genre.")
+             * @Assert\Choice(choices={"fiction", "non-fiction"}, message="Choose a valid genre.")
              */
             protected $genre;
         }
@@ -159,7 +159,7 @@ constraint.
         class Author
         {
             /**
-             * @Assert\Choice(callback = "getGenres")
+             * @Assert\Choice(callback="getGenres")
              */
             protected $genre;
         }
@@ -224,7 +224,7 @@ you can pass the class name and the method as an array.
         class Author
         {
             /**
-             * @Assert\Choice(callback = {"Util", "getGenres"})
+             * @Assert\Choice(callback={"Util", "getGenres"})
              */
             protected $genre;
         }
diff --git a/reference/constraints/IsTrue.rst b/reference/constraints/IsTrue.rst
@@ -55,7 +55,7 @@ Then you can constrain this method with ``IsTrue``.
             protected $token;
 
             /**
-             * @Assert\IsTrue(message = "The token is invalid")
+             * @Assert\IsTrue(message="The token is invalid")
              */
             public function isTokenValid()
             {
diff --git a/reference/constraints/Luhn.rst b/reference/constraints/Luhn.rst
@@ -34,7 +34,7 @@ will contain a credit card number.
         class Transaction
         {
             /**
-             * @Assert\Luhn(message = "Please check your credit card number.")
+             * @Assert\Luhn(message="Please check your credit card number.")
              */
             protected $cardNumber;
         }
diff --git a/reference/constraints/Valid.rst b/reference/constraints/Valid.rst
@@ -65,7 +65,7 @@ stores an ``Address`` instance in the ``$address`` property.
 
             /**
              * @Assert\NotBlank
-             * @Assert\Length(max = 5)
+             * @Assert\Length(max=5)
              */
             protected $zipCode;
         }
@@ -79,7 +79,7 @@ stores an ``Address`` instance in the ``$address`` property.
         {
             /**
              * @Assert\NotBlank
-             * @Assert\Length(min = 4)
+             * @Assert\Length(min=4)
              */
             protected $firstName;
 
diff --git a/routing.rst b/routing.rst
@@ -179,7 +179,7 @@ To fix this, add a *requirement* that the ``{page}`` wildcard can *only* match n
         class BlogController extends Controller
         {
             /**
-             * @Route("/blog/{page}", name="blog_list", requirements={"page": "\d+"})
+             * @Route("/blog/{page}", name="blog_list", requirements={"page"="\d+"})
              */
             public function listAction($page)
             {
@@ -277,7 +277,7 @@ So how can you make ``blog_list`` once again match when the user visits
         class BlogController extends Controller
         {
             /**
-             * @Route("/blog/{page}", name="blog_list", requirements={"page": "\d+"})
+             * @Route("/blog/{page}", name="blog_list", requirements={"page"="\d+"})
              */
             public function listAction($page = 1)
             {
diff --git a/routing/optional_placeholders.rst b/routing/optional_placeholders.rst
@@ -135,7 +135,7 @@ This is done by including it in the ``defaults`` collection:
         // ...
 
         /**
-         * @Route("/blog/{page}", defaults={"page" = 1})
+         * @Route("/blog/{page}", defaults={"page"=1})
          */
         public function indexAction($page)
         {
diff --git a/routing/requirements.rst b/routing/requirements.rst
@@ -21,7 +21,7 @@ a routing ``{wildcard}`` to only match some regular expression:
         class BlogController extends Controller
         {
             /**
-             * @Route("/blog/{page}", name="blog_list", requirements={"page": "\d+"})
+             * @Route("/blog/{page}", name="blog_list", requirements={"page"="\d+"})
              */
             public function listAction($page)
             {
@@ -97,8 +97,8 @@ URL:
         class MainController extends Controller
         {
             /**
-             * @Route("/{_locale}", defaults={"_locale": "en"}, requirements={
-             *     "_locale": "en|fr"
+             * @Route("/{_locale}", defaults={"_locale"="en"}, requirements={
+             *     "_locale"="en|fr"
              * })
              */
             public function homepageAction($_locale)
diff --git a/templating/formats.rst b/templating/formats.rst
@@ -51,7 +51,7 @@ be configured so that ``/about-us`` sets the request format to ``html`` while
 special ``_format`` placeholder in your route definition::
 
     /**
-     * @Route("/{slug}.{_format}", defaults={"_format": "html"})
+     * @Route("/{slug}.{_format}", defaults={"_format"="html"})
      */
     public function showAction(Request $request, $slug)
     {
diff --git a/validation.rst b/validation.rst
@@ -642,7 +642,7 @@ this method must return ``true``:
         class Author
         {
             /**
-             * @Assert\IsTrue(message = "The password cannot match your first name")
+             * @Assert\IsTrue(message="The password cannot match your first name")
              */
             public function isPasswordLegal()
             {
diff --git a/validation/severity.rst b/validation/severity.rst
@@ -38,17 +38,17 @@ Use the ``payload`` option to configure the error level for each constraint:
         class User
         {
             /**
-             * @Assert\NotBlank(payload = {"severity" = "error"})
+             * @Assert\NotBlank(payload={"severity"="error"})
              */
             protected $username;
 
             /**
-             * @Assert\NotBlank(payload = {"severity" = "error"})
+             * @Assert\NotBlank(payload={"severity"="error"})
              */
             protected $password;
 
             /**
-             * @Assert\Iban(payload = {"severity" = "warning"})
+             * @Assert\Iban(payload={"severity"="warning"})
              */
             protected $bankAccountNumber;
         }
diff --git a/validation/translations.rst b/validation/translations.rst
@@ -33,7 +33,7 @@ property is not empty, add the following:
         class Author
         {
             /**
-             * @Assert\NotBlank(message = "author.name.not_blank")
+             * @Assert\NotBlank(message="author.name.not_blank")
              */
             public $name;
         }

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ If your valid choice list is simple, you can pass them in directly via the`
`52`	`52`	`protected $city;`
`53`	`53`
`54`	`54`	`/**`
`55`		`- * @Assert\Choice(choices = {"fiction", "non-fiction"}, message = "Choose a valid genre.")`
	`55`	`+ * @Assert\Choice(choices={"fiction", "non-fiction"}, message="Choose a valid genre.")`
`56`	`56`	`*/`
`57`	`57`	`protected $genre;`
`58`	`58`	`}`
`@@ -159,7 +159,7 @@ constraint.`
`159`	`159`	`class Author`
`160`	`160`	`{`
`161`	`161`	`/**`
`162`		`- * @Assert\Choice(callback = "getGenres")`
	`162`	`+ * @Assert\Choice(callback="getGenres")`
`163`	`163`	`*/`
`164`	`164`	`protected $genre;`
`165`	`165`	`}`
`@@ -224,7 +224,7 @@ you can pass the class name and the method as an array.`
`224`	`224`	`class Author`
`225`	`225`	`{`
`226`	`226`	`/**`
`227`		`- * @Assert\Choice(callback = {"Util", "getGenres"})`
	`227`	`+ * @Assert\Choice(callback={"Util", "getGenres"})`
`228`	`228`	`*/`
`229`	`229`	`protected $genre;`
`230`	`230`	`}`
Original file line number	Diff line number	Diff line change
@@ -55,7 +55,7 @@ Then you can constrain this method with ``IsTrue``.
`55`	`55`	`protected $token;`
`56`	`56`
`57`	`57`	`/**`
`58`		`- * @Assert\IsTrue(message = "The token is invalid")`
	`58`	`+ * @Assert\IsTrue(message="The token is invalid")`
`59`	`59`	`*/`
`60`	`60`	`public function isTokenValid()`
`61`	`61`	`{`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ will contain a credit card number.`
`34`	`34`	`class Transaction`
`35`	`35`	`{`
`36`	`36`	`/**`
`37`		`- * @Assert\Luhn(message = "Please check your credit card number.")`
	`37`	`+ * @Assert\Luhn(message="Please check your credit card number.")`
`38`	`38`	`*/`
`39`	`39`	`protected $cardNumber;`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
@@ -179,7 +179,7 @@ To fix this, add a requirement that the ``{page}`` wildcard can only match n
`179`	`179`	`class BlogController extends Controller`
`180`	`180`	`{`
`181`	`181`	`/**`
`182`		`- * @Route("/blog/{page}", name="blog_list", requirements={"page": "\d+"})`
	`182`	`+ * @Route("/blog/{page}", name="blog_list", requirements={"page"="\d+"})`
`183`	`183`	`*/`
`184`	`184`	`public function listAction($page)`
`185`	`185`	`{`
@@ -277,7 +277,7 @@ So how can you make ``blog_list`` once again match when the user visits
`277`	`277`	`class BlogController extends Controller`
`278`	`278`	`{`
`279`	`279`	`/**`
`280`		`- * @Route("/blog/{page}", name="blog_list", requirements={"page": "\d+"})`
	`280`	`+ * @Route("/blog/{page}", name="blog_list", requirements={"page"="\d+"})`
`281`	`281`	`*/`
`282`	`282`	`public function listAction($page = 1)`
`283`	`283`	`{`
Original file line number	Diff line number	Diff line change
@@ -135,7 +135,7 @@ This is done by including it in the ``defaults`` collection:
`135`	`135`	`// ...`
`136`	`136`
`137`	`137`	`/**`
`138`		`- * @Route("/blog/{page}", defaults={"page" = 1})`
	`138`	`+ * @Route("/blog/{page}", defaults={"page"=1})`
`139`	`139`	`*/`
`140`	`140`	`public function indexAction($page)`
`141`	`141`	`{`
Original file line number	Diff line number	Diff line change
@@ -21,7 +21,7 @@ a routing ``{wildcard}`` to only match some regular expression:
`21`	`21`	`class BlogController extends Controller`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`		`- * @Route("/blog/{page}", name="blog_list", requirements={"page": "\d+"})`
	`24`	`+ * @Route("/blog/{page}", name="blog_list", requirements={"page"="\d+"})`
`25`	`25`	`*/`
`26`	`26`	`public function listAction($page)`
`27`	`27`	`{`
`@@ -97,8 +97,8 @@ URL:`
`97`	`97`	`class MainController extends Controller`
`98`	`98`	`{`
`99`	`99`	`/**`
`100`		`- * @Route("/{_locale}", defaults={"_locale": "en"}, requirements={`
`101`		`- * "_locale": "en\|fr"`
	`100`	`+ * @Route("/{_locale}", defaults={"_locale"="en"}, requirements={`
	`101`	`+ * "_locale"="en\|fr"`
`102`	`102`	`* })`
`103`	`103`	`*/`
`104`	`104`	`public function homepageAction($_locale)`
Original file line number	Diff line number	Diff line change
@@ -51,7 +51,7 @@ be configured so that ``/about-us`` sets the request format to ``html`` while
`51`	`51`	special ``_format`` placeholder in your route definition::
`52`	`52`
`53`	`53`	`/**`
`54`		`- * @Route("/{slug}.{_format}", defaults={"_format": "html"})`
	`54`	`+ * @Route("/{slug}.{_format}", defaults={"_format"="html"})`
`55`	`55`	`*/`
`56`	`56`	`public function showAction(Request $request, $slug)`
`57`	`57`	`{`
Original file line number	Diff line number	Diff line change
@@ -642,7 +642,7 @@ this method must return ``true``:
`642`	`642`	`class Author`
`643`	`643`	`{`
`644`	`644`	`/**`
`645`		`- * @Assert\IsTrue(message = "The password cannot match your first name")`
	`645`	`+ * @Assert\IsTrue(message="The password cannot match your first name")`
`646`	`646`	`*/`
`647`	`647`	`public function isPasswordLegal()`
`648`	`648`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ property is not empty, add the following:`
`33`	`33`	`class Author`
`34`	`34`	`{`
`35`	`35`	`/**`
`36`		`- * @Assert\NotBlank(message = "author.name.not_blank")`
	`36`	`+ * @Assert\NotBlank(message="author.name.not_blank")`
`37`	`37`	`*/`
`38`	`38`	`public $name;`
`39`	`39`	`}`