Skip to content

[RFC] Clarification on formatting for bangs (!) #4457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 10 commits into from
Closed

[RFC] Clarification on formatting for bangs (!) #4457

Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7077a54
[RFC] Clarification on formatting for bangs (!)
bryanagee Nov 13, 2014
bb51e3b
Reverses statement about bang spacing and corresponding examples
bryanagee Nov 13, 2014
75c4fc2
Adds bullet addressing bang placement
bryanagee Nov 13, 2014
9736b15
Fixes wrong bullet character
bryanagee Nov 13, 2014
119d94e
Fixes spelling and formatting errors
bryanagee Nov 13, 2014
87279d2
Adds missing space before return statement
bryanagee Nov 13, 2014
c2fa7db
Changes operator spacing language
bryanagee Nov 13, 2014
ccc99e6
Merge branch 'master' into bang-spacing-clarification
bryanagee Nov 13, 2014
de4c018
Incorporates @WouterJ 's suggestion for more realistic usage of bang
bryanagee Nov 14, 2014
d7949fd
Fixes concat operator typo
bryanagee Nov 24, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion contributing/code/standards.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,25 @@ example containing most features described below:

throw new \RuntimeException(sprintf('Unrecognized dummy option "%s"', $dummy));
}

private function reverseBoolean($value = null)
{
if (!isset($value)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$value is always set. So this is a redundant check. if (!$value) would be against the CS, so I propose to add another switch which defaults to false or the like to do something else and then use if (!$theSwitch)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indeed, we never use !isset($value) to check for null, but null === $value

return;
}
return !$value;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing empty line above return

}
}

Structure
---------

* Add a single space after each comma delimiter;

* Add a single space around operators (``==``, ``&&``, ...);
* Add a single space around operators (``==``, ``&&``, ...), with the excption
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

exception

of the not (!) operator;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please put the ! into literals (double backticks).


* Place the not operator adjacent to the variable that it affects
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a semicolon at the end of the sentence.


* Add a comma after each array item in a multi-line array, even after the
last one;
Expand Down