Adds documentation for PregQuoteDelimiter #2487
Conversation
|
Just documenting here that I chatted in person with @tikifez and he will add valid and invalid examples. No need to review this PR yet. |
|
Added code comparison with valid and invalid examples. |
1 similar comment
|
Added code comparison with valid and invalid examples. |
There was a problem hiding this comment.
Thanks for working on this PR, @tikifez! I'm not a maintainer of the project so take my review with a grain of salt. That being said, I left some comments based on my own experience creating PHPCS and WPCS sniffs.
Also, please make sure to include a reference to the parent issue as mentioned in the description of #1722:
Please mention this issue in your pull request description Related to #1722 so your pull request will show up in this issue.
| title="Preg Quote Delimiter" | ||
| > | ||
| <standard> | ||
| <![CDATA[ |
There was a problem hiding this comment.
<![CDATA should be aligned with <standard>. Here is an example of a recently added documentation: https://github.com/rodrigoprimo/WordPress-Coding-Standards/blob/694bdf514d518004cefc0a22923fedeb0091eaca/WordPress/Docs/WP/GetMetaSingleStandard.xml#L7
Here and in the other places where <![CDATA is used.
| Passing the $delimiter parameter to preg_quote() is strongly recommended to ensure the delimiter required by the PCRE functions are escaped. | ||
| ]]> | ||
| </standard> | ||
|
|
There was a problem hiding this comment.
This newline is not necessary.
| > | ||
| <standard> | ||
| <
| ]]> | ||
| </code> | ||
| </code_comparison> | ||
| </documentation> |
There was a problem hiding this comment.
Add a clear line at the end of the file please.
| <code_comparison> | ||
| <code title="Valid: The delimiter is included."> | ||
| <
Related to #1722