Skip to content

Add XML documentation for OperatorSpacingSniff #2543

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
AnuragGaonkar wants to merge 1 commit into from
Closed

Add XML documentation for OperatorSpacingSniff #2543

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 17 additions & 8 deletions WordPress/Docs/WhiteSpace/OperatorSpacingStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,33 @@
<![CDATA[
Always put one space on both sides of logical, comparison and concatenation operators.
Always put one space after an assignment operator.
Most of these can be auto-fixed by PHP_CodeSniffer.
]]>
</standard>



<code_comparison>
<code title="Valid: One space before and after an operator.">
<![CDATA[
if ( $a<em> === </em>$b<em> && </em>$b<em> === </em>$c ) {}
if (<em> ! </em>$var ) {}
if ( $a === $b && $b === $c ) {}
Copy link
Copy Markdown
Member

@dingo-d dingo-d Jul 17, 2025

Choose a reason for hiding this comment

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

You shouldn't remove emphasis on errors. They serve a purpose (when you use HTML generator type you will see these bolded).

A lot of these fixes aren't valid...

if ( ! $var ) {}
]]>
</code>


<code title="Invalid: Too much/little space.">
<![CDATA[
// Too much space.
if ( $a === $b<em> && </em>$b<em> === </em>$c ) {}
if (<em> ! </em>$var ) {}
// Too much space.
if ( $a === $b && $b === $c ) {}
if ( ! $var ) {}

// Too little space.
if ( $a<em>===</em>$b<em> &&</em>$b<em> ===</em>$c ) {}
if (<em> !</em>$var ) {}
// Too little space.
if ( $a=== $b &&$b ===$c ) {}
if ( ! $var ) {}
]]>
</code>

</code_comparison>
<code_comparison>
<code title="Valid: A new line instead of a space is okay too.">
Expand Down Expand Up @@ -58,4 +65,6 @@ $all <em>=</em>'foobar';
]]>
</code>
</code_comparison>


</documentation>
Loading