Skip to content

Commit 13e2035

Browse files
Improve test descriptions based on code review feedback
Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>
1 parent d88cb25 commit 13e2035

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -471,9 +471,9 @@ These tests run against your source code files in the `src` directory:
471471
| Test ID | Description | Example Skip Comment |
472472
|---------|-------------|---------------------|
473473
| `NumberOfProcessors` | Enforces use of `[System.Environment]::ProcessorCount` instead of `$env:NUMBER_OF_PROCESSORS` | `#SkipTest:NumberOfProcessors:Legacy code compatibility required` |
474-
| `Verbose` | Ensures `-Verbose` is not used unless explicitly disabled with `:$false` | `#SkipTest:Verbose:Required for debugging output` |
475-
| `OutNull` | Enforces use of `$null = ...` instead of `... \| Out-Null` for better performance | `#SkipTest:OutNull:Pipeline output needed for compatibility` |
476-
| `NoTernary` | Checks for ternary operators (currently skipped by default for PowerShell 7+ compatibility) | `#SkipTest:NoTernary:PowerShell 7+ only module` |
474+
| `Verbose` | Prevents use of `-Verbose` parameter in code (should only be used with `:$false` qualifier to explicitly disable) | `#SkipTest:Verbose:Required for debugging output` |
475+
| `OutNull` | Enforces use of `$null = ...` instead of `... \| Out-Null` for better performance | `#SkipTest:OutNull:Pipeline processing required` |
476+
| `NoTernary` | Prohibits ternary operators for PowerShell 5.1 compatibility (this test is skipped by default in the framework) | `#SkipTest:NoTernary:PowerShell 7+ only module` |
477477
| `LowercaseKeywords` | Ensures all PowerShell keywords are lowercase | `#SkipTest:LowercaseKeywords:Generated code` |
478478
| `FunctionCount` | Ensures each file contains exactly one function | `#SkipTest:FunctionCount:Helper functions included` |
479479
| `FunctionName` | Ensures the filename matches the function name | `#SkipTest:FunctionName:Legacy naming convention` |

0 commit comments

Comments
 (0)