Docs: Add documentation for WordPress.PHP.TypeCasts #2591
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,38 @@ | ||||||
| <?xml version="1.0"?> | ||||||
| <documentation title="Type Casts"> | ||||||
| <standard> | ||||||
| <![CDATA[ | ||||||
| This sniff normalizes float type cast keywords. | ||||||
|
There was a problem hiding this comment. Reworded the opener to be shorter and clearer. It now states the rules enforced without repeating itself. |
||||||
|
|
||||||
| Use (float) instead of legacy synonyms: | ||||||
| - Disallowed: (double), (real) | ||||||
| - Allowed: (float) | ||||||
|
There was a problem hiding this comment. This is incorrect/incomplete. The sniff:
Considering the above, I believe the code samples also need work. There was a problem hiding this comment. Updated the standard text and the code examples to cover all three behaviors: |
||||||
|
|
||||||
| Note: Other type-cast rules in the WordPress standard | ||||||
| are enforced by different sniffs: | ||||||
| - Short forms like (int), (bool), (string): | ||||||
| PSR12.Keywords.ShortFormTypeKeywords | ||||||
| - No spaces inside parentheses: | ||||||
| Squiz.WhiteSpace.CastSpacing | ||||||
| - Exactly one space after the cast: | ||||||
| Generic.Formatting.SpaceAfterCast | ||||||
|
There was a problem hiding this comment. This whole block doesn't belong here. Each sniff functions independently of other sniffs. That also means that the docs should be independent of each other and should just focus on what this sniff does. There was a problem hiding this comment. Thanks! I’ve removed the paragraph referencing other sniffs. The docs now only describe what WordPress.PHP.TypeCasts enforces. |
||||||
| ]]> | ||||||
| </standard> | ||||||
|
|
||||||
| <code_comparison> | ||||||
|
There was a problem hiding this comment. The code comparison should have "valid" on the left (first code sample), "invalid" on the right (second code sample). There was a problem hiding this comment. Thanks for the feedback! I’ve reordered the code examples so that Valid is on the left and Invalid is on the right, as suggested. |
||||||
| <code title="Invalid: legacy float casts"> | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. Adjusted the code block titles to your suggested wording. |
||||||
| <![CDATA[ | ||||||
| <?php | ||||||
|
There was a problem hiding this comment. PHP open tag is not needed here. (Same for the "invalid" code sample) There was a problem hiding this comment. Removed <?php from all code samples as suggested. |
||||||
| $price = <em>(double)</em> $value; | ||||||
| $size = <em>(real)</em> $value; | ||||||
| ]]> | ||||||
| </code> | ||||||
| <code title="Valid: normalized float cast"> | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. Adjusted the code block titles to your suggested wording. There was a problem hiding this comment. Updated code block titles to “Valid: Using normalized float casts.” (and similar phrasing for the other examples), as suggested. |
||||||
| <![CDATA[ | ||||||
| <?php | ||||||
| $price = <em>(float)</em> $value; | ||||||
| $size = <em>(float)</em> $value; | ||||||
| ]]> | ||||||
| </code> | ||||||
| </code_comparison> | ||||||
| </documentation> | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added the schema header and xsi:noNamespaceSchemaLocation pointing to phpcsdocs.xsd.