[Contributing] [Standards] Added entry for Yoda conditions #5402

phansys · 2015-06-15T15:29:09Z

Q	A
Doc fix?	yes
New docs?	no
Applies to	2.8+
Fixed tickets

stof · 2015-06-15T15:46:49Z

This is part of the coding standards actually (and I'm quite sure it is already documented)

phansys · 2015-06-15T15:53:11Z

I didn't see any entry about this @stof: https://symfony.com/doc/current/contributing/code/standards.html

stof · 2015-06-15T16:00:24Z

I thought it was mentioned. Can you update your PR to mention it on this page instead then ?

phansys · 2015-06-15T16:12:41Z

@stof, updated.

javiereguiluz · 2015-06-16T14:42:00Z

contributing/code/standards.rst

+Use `Yoda condition`_ when you need to check a variable against a value.
+The main goal with this syntax is to avoid an accidental assignment inside the
+condition statements:
+


What if we reword this paragraph to make it much shorter?

Use `Yoda conditions`_ when checking a variable against a value to avoid an accidental assignment inside the condition statements:

@javiereguiluz, updated.

soullivaneuh · 2015-06-22T08:05:28Z

@stof @phansys BTW, having a little more explanation of why this choice on the docs would be useful for non adept developers. 👍

javiereguiluz · 2015-06-22T08:30:06Z

👍 I think this PR is now ready to be labeled as finished and to be merged soon. Thanks!

xabbuh · 2015-06-22T16:21:24Z

👍

soullivaneuh · 2015-06-22T18:08:39Z

Regarding to WordPress coding style from where Yoda condition from (AFAIK):

Yoda conditions for <, >, <= or >= are significantly more difficult to read and are best avoided.

Is I understand well, Yoda condition should be avoided for <, >, <= or >=, isn't it?

If yes, it should be clearly specified on this doc too.

wouterj · 2015-06-26T14:06:36Z

contributing/code/standards.rst

+----------
+
+Use `Yoda condition`_ when checking a variable against a value to avoid an
+accidental assignment inside the condition statements::


I think we should add this to the list of standards, instead of creating a custom section purely for one standard.

* Use `Yoda conditions`_ when checking a variable against a value to avoid an accidental assignment inside the condition statements.

I would also specify:

Yoda condition are not recommended for operators like `<`, `>`, `<=` or `>=`.

@wouterj, you mean in structure section?

@soullivaneuh, I think there is no possibility of accidental assignment in < and >, so I agree with both of these.

Moved inside "structure" section. It would be nice to know what others think about @soullivaneuh proposal.

xabbuh · 2015-06-26T15:24:12Z

contributing/code/standards.rst

@@ -100,6 +100,9 @@ Structure

 * Place unary operators (``!``, ``--``, ...) adjacent to the affected variable;

+* Use `Yoda condition`_ when checking a variable against an expression to avoid


I guess the correct wording would be "Use Yoda conditions" or "Use a Yoda condition" (the first sounds more natural to me).

| Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.8+ | Fixed tickets |

soullivaneuh · 2015-06-26T15:54:44Z

contributing/code/standards.rst

@@ -100,6 +100,9 @@ Structure

 * Place unary operators (``!``, ``--``, ...) adjacent to the affected variable;

+* Use `Yoda conditions`_ when checking a variable against an expression to avoid


Please consider my comment: #5402 (comment)

Is contributors are agree with it of course.

Yes @soullivaneuh, I'd like to hear more thoughts on this.

…s (phansys) This PR was submitted for the 2.8 branch but it was merged into the 2.3 branch instead (closes #5402). Discussion ---------- [Contributing] [Standards] Added entry for Yoda conditions | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.8+ | Fixed tickets | Commits ------- 023a96f [Contributing] [Conventions] Added entry for Yoda conditions

…hings like >=)

weaverryan · 2015-06-28T17:57:50Z

Thanks @phansys! @soullivaneuh I took some liberty and added your suggestion at sha: d606f3e

Cheers!

soullivaneuh · 2015-06-28T18:01:28Z

@weaverryan 👍

@xabbuh

* 2.3: Changed PhpStormOpener to PhpStormProtocol [#5402] Being explicit what this applies to (it should not apply to things like >=) [Contributing] [Conventions] Added entry for Yoda conditions Document security.switch_user event Added some more docs about the remember me feature Fixed a minor grammar issue Fixed a minor grammar issue Added support for standard Forwarded header Added support for standard Forwarded header Fixed issues reported by @xabbuh Remove the Propel book chapter and explain why we do that

@xabbuh

* 2.6: Changed PhpStormOpener to PhpStormProtocol [#5402] Being explicit what this applies to (it should not apply to things like >=) [Contributing] [Conventions] Added entry for Yoda conditions Added the "payload" option back Show annotations first Reordered the code blocks to show Annotations, YAML, XML and PHP Fixed the issues reported by @xabbuh Finished the documentation of the new data comparison validators Added information about the new date handling in the comparison constraints and Range Document security.switch_user event Added some more docs about the remember me feature Fixed a minor grammar issue Fixed a minor grammar issue Added support for standard Forwarded header Added support for standard Forwarded header Fixed issues reported by @xabbuh Remove the Propel book chapter and explain why we do that

@xabbuh

* 2.7: (21 commits) Changed PhpStormOpener to PhpStormProtocol [#5402] Being explicit what this applies to (it should not apply to things like >=) [Contributing] [Conventions] Added entry for Yoda conditions Added the "payload" option back Show annotations first Reordered the code blocks to show Annotations, YAML, XML and PHP Fixed the issues reported by @xabbuh Finished the documentation of the new data comparison validators Added information about the new date handling in the comparison constraints and Range Document security.switch_user event [#5332] typo [#5335] Minor tweaks Added some more docs about the remember me feature [Serializer] Updated the cookbook. Fixed a minor grammar issue Fixed a minor grammar issue [Serializer] ObjectNormalizer, object_to_populate doc. Minor enhancements. Added support for standard Forwarded header Added support for standard Forwarded header Fixed issues reported by @xabbuh ...

@xabbuh

* 2.8: (22 commits) Changed PhpStormOpener to PhpStormProtocol [#5402] Being explicit what this applies to (it should not apply to things like >=) [Contributing] [Conventions] Added entry for Yoda conditions Added the "payload" option back Show annotations first Reordered the code blocks to show Annotations, YAML, XML and PHP Fixed the issues reported by @xabbuh Finished the documentation of the new data comparison validators Added information about the new date handling in the comparison constraints and Range Document security.switch_user event [#5332] typo [#5335] Minor tweaks document new Doctrine APC cache service Added some more docs about the remember me feature [Serializer] Updated the cookbook. Fixed a minor grammar issue Fixed a minor grammar issue [Serializer] ObjectNormalizer, object_to_populate doc. Minor enhancements. Added support for standard Forwarded header Added support for standard Forwarded header ...

phansys changed the title ~~[Contributing] [Conventions] Added entry for Yoda conditions~~ [Contributing] [Standards] Added entry for Yoda conditions Jun 15, 2015

javiereguiluz reviewed Jun 16, 2015
View reviewed changes

phansys force-pushed the conventions_yoda_conditions branch from 8ceac05 to 55d0a69 Compare June 16, 2015 21:47

phansys mentioned this pull request Jun 22, 2015

[Thumbnail] Fix thumbnail URL for reference format sonata-project/SonataMediaBundle#787

Closed

xabbuh added the Status: Reviewed label Jun 22, 2015

wouterj reviewed Jun 26, 2015
View reviewed changes

wouterj added Status: Needs Work and removed Status: Reviewed labels Jun 26, 2015

phansys mentioned this pull request Jun 26, 2015

[Contributing] [Standards] Added entry for identical comparison #5403

Closed

xabbuh reviewed Jun 26, 2015
View reviewed changes

[Contributing] [Conventions] Added entry for Yoda conditions

844ac8e

| Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.8+ | Fixed tickets |

phansys force-pushed the conventions_yoda_conditions branch from d1e9207 to 844ac8e Compare June 26, 2015 15:27

soullivaneuh reviewed Jun 26, 2015
View reviewed changes

wouterj added Status: Reviewed and removed Status: Needs Work labels Jun 26, 2015

weaverryan added a commit that referenced this pull request Jun 28, 2015

[#5402] Being explicit what this applies to (it should not apply to t…

d606f3e

…hings like >=)

weaverryan closed this Jun 28, 2015

phansys deleted the conventions_yoda_conditions branch June 29, 2015 18:43

wouterj removed the Status: Reviewed label Jul 22, 2015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Contributing] [Standards] Added entry for Yoda conditions #5402

[Contributing] [Standards] Added entry for Yoda conditions #5402

phansys commented Jun 15, 2015

stof commented Jun 15, 2015

phansys commented Jun 15, 2015

stof commented Jun 15, 2015

phansys commented Jun 15, 2015

javiereguiluz Jun 16, 2015

phansys Jun 16, 2015

soullivaneuh commented Jun 22, 2015

javiereguiluz commented Jun 22, 2015

xabbuh commented Jun 22, 2015

soullivaneuh commented Jun 22, 2015

wouterj Jun 26, 2015

soullivaneuh Jun 26, 2015

phansys Jun 26, 2015

phansys Jun 26, 2015

xabbuh Jun 26, 2015

phansys Jun 26, 2015

soullivaneuh Jun 26, 2015

phansys Jun 26, 2015

weaverryan commented Jun 28, 2015

soullivaneuh commented Jun 28, 2015

		@@ -100,6 +100,9 @@ Structure

		* Place unary operators (``!``, ``--``, ...) adjacent to the affected variable;

		* Use `Yoda condition`_ when checking a variable against an expression to avoid

		@@ -100,6 +100,9 @@ Structure

		* Place unary operators (``!``, ``--``, ...) adjacent to the affected variable;

		* Use `Yoda conditions`_ when checking a variable against an expression to avoid

[Contributing] [Standards] Added entry for Yoda conditions #5402

[Contributing] [Standards] Added entry for Yoda conditions #5402

Conversation

phansys commented Jun 15, 2015

stof commented Jun 15, 2015

phansys commented Jun 15, 2015

stof commented Jun 15, 2015

phansys commented Jun 15, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soullivaneuh commented Jun 22, 2015

javiereguiluz commented Jun 22, 2015

xabbuh commented Jun 22, 2015

soullivaneuh commented Jun 22, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weaverryan commented Jun 28, 2015

soullivaneuh commented Jun 28, 2015