Skip to content

Commit 537f519

Browse files
committed
Grammar by Grazie Pro plugin for PhpStorm.
1 parent 5d84252 commit 537f519

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

RULES.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ These WordPress PHPCS rules are **disabled** in WPForms projects:
1919
### Spacing & Indentation
2020
- **`Generic.WhiteSpace.ScopeIndent`** - Less strict indenting allowed
2121
- **`Generic.Functions.FunctionCallArgumentSpacing`** - Less strict argument spacing
22-
- **`WordPress.WhiteSpace.PrecisionAlignment`** - Precision alignment not enforced
22+
- **`WordPress.WhiteSpace.PrecisionAlignment`** - Precision alignment isn't enforced
2323

2424
### File Naming (PSR-4 Support)
2525
- **`WordPress.Files.FileName.InvalidClassFileName`** - Allows PSR-4 class file naming
2626
- **`WordPress.Files.FileName.NotHyphenatedLowercase`** - Allows PSR-4 naming conventions
2727

2828
### Comments
2929
- **`Squiz.Commenting.InlineComment.SpacingAfter`** - Less strict inline comment spacing
30-
- **`Squiz.Commenting.FileComment.*`** - File-level PHPDoc not required
30+
- **`Squiz.Commenting.FileComment.*`** - File-level PHPDoc isn't required
3131

3232
### Yoda Conditions
3333
- **`WordPress.PHP.YodaConditions.NotYoda`** - Yoda conditions are **NOT** required
@@ -535,7 +535,7 @@ do_action( 'wpforms_settings_saved' );
535535
do_action( 'wpforms_settings_saved' );
536536
```
537537

538-
**Rule 3:** Hook PHPDoc **must** have `@since` tag with valid version.
538+
**Rule 3:** Hook PHPDoc **must** have `@since` tag with a valid version.
539539

540540
**Rule 4:** Hook PHPDoc **must** have `@param` tags matching the number of arguments passed to the hook (excluding the hook name itself).
541541

@@ -616,7 +616,7 @@ do_action_deprecated( 'wpforms_user_process', [ $user_id ], '2.0.0' );
616616

617617
**Rule 2:** `define()` PHPDoc must have a short description ending with punctuation.
618618

619-
**Rule 3:** `define()` PHPDoc must have `@since` tag with valid version.
619+
**Rule 3:** `define()` PHPDoc must have `@since` tag with a valid version.
620620

621621
**Rule 4:** No empty line should appear after `@since` tag in `define()` PHPDoc (different from functions/classes).
622622

@@ -681,9 +681,9 @@ $sql = "SELECT * FROM users";
681681
- Before case statements after break
682682
- No empty line before break in switch
683683

684-
2. **No Yoda conditions** - Write naturally: `$var === 'value'`
684+
2. **No Yoda conditions** Write naturally: `$var === 'value'`
685685

686-
3. **Short array syntax** - Use `[]` not `array()`
686+
3. **Short array syntax** Use `[]` not `array()`
687687

688688
#### Documentation
689689
4. **@since tag required** on:
@@ -694,8 +694,8 @@ $sql = "SELECT * FROM users";
694694

695695
5. **PHPDoc descriptions must:**
696696
- End with punctuation (`.`, `!`, `?`)
697-
- Start on line after `/**` opening
698-
- Not be on same line as `/**`
697+
- Start on the next line after `/**` opening
698+
- Not be on the same line as `/**`
699699

700700
6. **Hook documentation:**
701701
- PHPDoc required directly above all hooks
@@ -715,13 +715,13 @@ $sql = "SELECT * FROM users";
715715

716716
9. **Text domain required** - Always specify domain in i18n functions
717717

718-
10. **Use statements over fully qualified names** - Import classes at top
718+
10. **Use statements over fully qualified names** Import classes at top
719719

720-
11. **Hook names** - Should start with class name in snake_case
720+
11. **Hook names** - Should start with the class name in snake_case
721721

722722
#### Quality
723723
12. **Translator comments** - Must have colon, description, and punctuation
724724

725-
13. **Complexity limits** - Keep functions under 6 complexity, 3 nesting levels
725+
13. **Complexity limits** Keep functions under 6 complexity, 3 nesting levels
726726

727-
14. **Tag spacing** - Only one space after `@param` and `@return`
727+
14. **Tag spacing** Only one space after `@param` and `@return`

0 commit comments

Comments
 (0)