Skip to content

Conversation

@AnuragGaonkar
Copy link

This PR adds XML documentation for the OperatorSpacingSniff under WordPress/Sniffs/WhiteSpace/.

  • Documents standard expectations and valid/invalid usage examples.
  • Structured with and <code_comparison> sections as per CONTRIBUTING.md
  • Follows the existing documentation format already in place.

Fixes: #2462

Copy link
Member

@dingo-d dingo-d left a comment

Choose a reason for hiding this comment

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

As mentioned in the comment, a lot of these aren't fixes.

I think this should be closed.

Please, check the contributing guide if you want to make contributions.

<![CDATA[
if ( $a<em> === </em>$b<em> && </em>$b<em> === </em>$c ) {}
if (<em> ! </em>$var ) {}
if ( $a === $b && $b === $c ) {}
Copy link
Member

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...

@jrfnl
Copy link
Member

jrfnl commented Jul 17, 2025

I agree with @dingo-d. There is nothing here which can be seen as an improvement.

@jrfnl
Copy link
Member

jrfnl commented Jul 17, 2025

Oh and it most definitely doesn't fix the linked issue. This just feels like AI slop, which is really not welcome here.

@AnuragGaonkar AnuragGaonkar deleted the docs/add-xml-guidelines branch October 26, 2025 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document how to write XML documentation files

3 participants