Skip to content

Commit 5a44a44

Browse files
committed
docs(readme): fix formatting and fix wording.
1 parent 2fd4594 commit 5a44a44

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ Functions that return a value must have a `@return` docblock tag.
198198
<td>✔️</td>
199199
<td>
200200

201-
- Fixes with a <code>mixed</code> return type
201+
- Fixes with a <code>mixed</code> return type.
202202

203203
- Magic methods (e.g. <code>\_\_construct</code>, <code>\_\_get</code>, etc.) are exempt.
204204

@@ -214,7 +214,11 @@ Functions that return a value must have a `@return` docblock tag.
214214
<td>Generator functions must have a <code>@return</code> tag.
215215
</td>
216216
<td>✔️</td>
217-
<td>Fixes with a <code>iterable</code> return type</td>
217+
<td>
218+
219+
- Fixes with an <code>iterable</code> return type.
220+
221+
</td>
218222
</tr>
219223
</table>
220224

@@ -347,7 +351,7 @@ public function formatString(string $input)
347351

348352
### yCodeTech.Types.DisallowTypeLongNames
349353

350-
Long type names are disallowed. Short names must be used in all contexts.
354+
Long type names are disallowed. Short names must be used in docblocks, type declarations, and type casting.
351355

352356
<table>
353357
<tr>
@@ -363,19 +367,31 @@ Long type names are disallowed. Short names must be used in all contexts.
363367
<td>✔️</td>
364368
</tr>
365369
<tr>
366-
<th>Contexts</th>
367-
<td>Docblocks, type declarations, union and nullable types, type casting, generic types</td>
370+
<th>Notes</th>
371+
<td>
372+
373+
- Docblocks and type declarations include union and nullable types.
374+
375+
- Docblock types can also include generic types.
376+
377+
- Types will only be fixed in these regular docblocks tags: `@param`, `@return`, `@var`, `@property`, `@method`.
378+
Also any other tags that contain the regular tags; example: `@property-read`, `@phpstan-param`, `@psalm-return`.
379+
380+
- Any types in docblock descriptions will not get fixed.
381+
382+
</td>
383+
368384
</tr>
369385
</table>
370386

371387
#### Violation Codes:
372388

373389
`yCodeTech.Types.DisallowTypeLongNames.DocblockType`
374390

375-
`yCodeTech.Types.DisallowTypeLongNames.TypeCast`
376-
377391
`yCodeTech.Types.DisallowTypeLongNames.TypeDeclaration`
378392

393+
`yCodeTech.Types.DisallowTypeLongNames.TypeCast`
394+
379395
#### Examples:
380396

381397
<table>

0 commit comments

Comments
 (0)