README fixes

Author: kukulich

doc/attributes.md

@@ -2,7 +2,7 @@
 
 #### SlevomatCodingStandard.Attributes.AttributeAndTargetSpacing 🔧
 
-Checks lines count between attribute and its target (or target's documentation comment).
+Sniff checks lines count between attribute and its target (or target's documentation comment).
 
 Sniff provides the following settings:
 
@@ -11,7 +11,7 @@ Sniff provides the following settings:
 
 #### SlevomatCodingStandard.Attributes.AttributesOrder 🔧
 
-Requires order of attributes. When more attributes are in one `#[]`, eg. `#[One, Two]`, the first attribute name is used to resolve the order.
+Requires order of attributes. When more attributes are in one `#[]`, e.g. `#[One, Two]`, the first attribute name is used to resolve the order.
 
 Sniff provides the following settings:
 

doc/classes.md

@@ -32,7 +32,7 @@ public const BAR = 2; // correct
 
 #### SlevomatCodingStandard.Classes.ClassMemberSpacing 🔧
 
-Checks lines count between different class members, eg. between last property and first method.
+Sniff checks lines count between different class members, e.g. between last property and first method.
 
 Sniff provides the following settings:
 
@@ -69,7 +69,7 @@ constants, properties, static properties, methods, all public methods, all prote
 
 			<element value="enum cases"/>
 
-			<!-- Public constants are first but you don't care about the order of protected or private constants -->
+			<!-- Public constants are first, but you don't care about the order of protected or private constants -->
 			<element value="public constants"/>
 			<element value="constants"/>
 
@@ -208,11 +208,11 @@ This sniff provides the following setting:
 
 #### SlevomatCodingStandard.Classes.RequireMultiLineMethodSignature 🔧
 
-Enforces method signature to be splitted to more lines so each parameter is on its own line.
+Enforces method signature to be split to more lines so each parameter is on its own line.
 
 Sniff provides the following settings:
 
-* `minLineLength`: specifies min line length to enforce signature to be splitted. Use 0 value to enforce for all methods, regardless of length.
+* `minLineLength`: specifies min line length to enforce signature to be split. Use 0 value to enforce for all methods, regardless of length.
 
 * `includedMethodPatterns`: allows to configure which methods are included in sniff detection. This is an array of regular expressions (PCRE) with delimiters. You should not use this with `excludedMethodPatterns`, as it will not work properly.
 
@@ -228,7 +228,7 @@ Enforces method signature to be on a single line.
 
 Sniff provides the following settings:
 
-* `maxLineLength`: specifies max allowed line length. If signature would fit on it, it's enforced. Use 0 value to enforce for all methods, regardless of length.
+* `maxLineLength`: specifies max allowed line length. If signature fit on it, it's enforced. Use 0 value to enforce for all methods, regardless of length.
 
 * `includedMethodPatterns`: allows to configure which methods are included in sniff detection. This is an array of regular expressions (PCRE) with delimiters. You should not use this with `excludedMethodPatterns`, as it will not work properly.
 

doc/commenting.md

@@ -6,7 +6,7 @@ Reports `@deprecated` annotations without description.
 
 #### SlevomatCodingStandard.Commenting.DisallowCommentAfterCode 🔧
 
-Disallows comments after code at the same line.
+Sniff disallows comments after code at the same line.
 
 #### SlevomatCodingStandard.Commenting.ForbiddenAnnotations 🔧
 
@@ -87,11 +87,11 @@ Requires property comments with single-line content to be written as one-liners.
 
 #### SlevomatCodingStandard.Commenting.RequireOneLineDocComment 🔧
 
-Requires comments with single-line content to be written as one-liners.
+Sniff requires comments with single-line content to be written as one-liners.
 
 #### SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment 🔧
 
-Requires comments with single-line content to be written as multi-liners.
+Sniff requires comments with single-line content to be written as multi-liners.
 
 #### SlevomatCodingStandard.Commenting.UselessFunctionDocComment 🔧
 
@@ -100,10 +100,10 @@ Requires comments with single-line content to be written as multi-liners.
 
 Sniff provides the following settings:
 
-* `traversableTypeHints`: enforces which typehints must have specified contained type. E. g. if you set this to `\Doctrine\Common\Collections\Collection`, then `\Doctrine\Common\Collections\Collection` must always be supplied with the contained type: `\Doctrine\Common\Collections\Collection|Foo[]`.
+* `traversableTypeHints`: enforces which typehints must have specified contained type. E.g. if you set this to `\Doctrine\Common\Collections\Collection`, then `\Doctrine\Common\Collections\Collection` must always be supplied with the contained type: `\Doctrine\Common\Collections\Collection|Foo[]`.
 
 This sniff can cause an error if you're overriding or implementing a parent method which does not have typehints. In such cases add `@phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint` annotation to the method to have this sniff skip it.
 
 #### SlevomatCodingStandard.Commenting.UselessInheritDocComment 🔧
 
-Reports documentation comments containing only `{@inheritDoc}` annotation because inheritance is automatic and it's not needed to use a special annotation for it.
+Reports documentation comments containing only `{@inheritDoc}` annotation because inheritance is automatic, and it's not needed to use a special annotation for it.

doc/control-structures.md

@@ -1,6 +1,5 @@
 ## Control structures
 
-
 #### SlevomatCodingStandard.ControlStructures.AssignmentInCondition
 
 Disallows assignments in `if`, `elseif` and `do-while` loop conditions:
@@ -118,13 +117,13 @@ Ternary operator has to be reformatted when the operator is not leading the line
 ```php
 # wrong
 $t = $someCondition ?
-  $thenThis :
-  $otherwiseThis;
+	$thenThis :
+	$otherwiseThis;
 
 # correct
 $t = $someCondition
-  ? $thenThis
-  : $otherwiseThis;
+	? $thenThis
+	: $otherwiseThis;
 ```
 
 #### SlevomatCodingStandard.ControlStructures.JumpStatementsSpacing 🔧

doc/files.md

@@ -15,8 +15,8 @@ Enforces maximum length of a single line of code.
 Sniff provides the following settings:
 
 * `lineLengthLimit`: actual limit of the line length
-* `ignoreComments`: whether or not to ignore line length of comments
-* `ignoreImports`: whether or not to ignore line length of import (use) statements
+* `ignoreComments`: whether to ignore line length of comments
+* `ignoreImports`: whether to ignore line length of import (use) statements
 
 #### SlevomatCodingStandard.Files.TypeNameMatchesFileName
 

doc/functions.md

@@ -38,11 +38,11 @@ Sniff provides the following settings:
 
 #### SlevomatCodingStandard.Functions.RequireMultiLineCall 🔧
 
-Enforces function call to be splitted to more lines so each parameter is on its own line.
+Enforces function call to be split to more lines so each parameter is on its own line.
 
 Sniff provides the following settings:
 
-* `minLineLength`: specifies min line length to enforce call to be splitted. Use 0 value to enforce for all calls, regardless of length.
+* `minLineLength`: specifies min line length to enforce call to be split. Use 0 value to enforce for all calls, regardless of length.
 
 #### SlevomatCodingStandard.Functions.RequireSingleLineCall 🔧
 

doc/namespaces.md

@@ -2,7 +2,7 @@
 
 #### SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses 🔧
 
-Checks whether uses at the top of a file are alphabetically sorted. Follows natural sorting and takes edge cases with special symbols into consideration. The following code snippet is an example of correctly sorted uses:
+Sniff checks whether `use` declarations at the top of a file are alphabetically sorted. Follows natural sorting and takes edge cases with special symbols into consideration. The following code snippet is an example of correctly sorted uses:
 
 ```php
 use LogableTrait;
@@ -128,7 +128,7 @@ Sniff provides the following settings:
 
 #### SlevomatCodingStandard.Namespaces.UseFromSameNamespace 🔧
 
-Prohibits uses from the same namespace:
+Sniff prohibits uses from the same namespace:
 
 ```php
 namespace Foo;
@@ -156,11 +156,11 @@ Sniff provides the following settings:
 
 #### SlevomatCodingStandard.Namespaces.UseOnlyWhitelistedNamespaces
 
-Disallows uses of other than configured namespaces.
+Sniff disallows uses of other than configured namespaces.
 
 Sniff provides the following settings:
 
-* `namespacesRequiredToUse`: namespaces in this array are the only ones allowed to be used. E. g. root project namespace.
+* `namespacesRequiredToUse`: namespaces in this array are the only ones allowed to be used. E.g. root project namespace.
 * `allowUseFromRootNamespace`: also allow using top-level namespace:
 
 ```php
@@ -178,5 +178,5 @@ Looks for unused imports from other namespaces.
 Sniff provides the following settings:
 
 * `searchAnnotations` (defaults to `false`): enables searching for class names in annotations.
-* `ignoredAnnotationNames`: case sensitive list of annotation names that the sniff should ignore (only the name is ignored, annotation content is still searched). Useful for name collisions like `@testCase` annotation and `TestCase` class.
-* `ignoredAnnotations`: case sensitive list of annotation names that the sniff ignore completely (both name and content are ignored). Useful for name collisions like `@group Cache` annotation and `Cache` class.
+* `ignoredAnnotationNames`: case-sensitive list of annotation names that the sniff should ignore (only the name is ignored, annotation content is still searched). Useful for name collisions like `@testCase` annotation and `TestCase` class.
+* `ignoredAnnotations`: case-sensitive list of annotation names that the sniff ignore completely (both name and content are ignored). Useful for name collisions like `@group Cache` annotation and `Cache` class.

doc/php.md

@@ -6,7 +6,7 @@ Disallows direct call of `__invoke()`.
 
 #### SlevomatCodingStandard.PHP.DisallowReference
 
-Disallows references.
+Sniff disallows usage of references.
 
 #### SlevomatCodingStandard.PHP.ForbiddenClasses 🔧
 
@@ -73,7 +73,7 @@ Looks for useless parentheses.
 
 Sniff provides the following settings:
 
-* `ignoreComplexTernaryConditions` (defaults to `false`): ignores complex ternary conditions - condition must contain `&&`, `||` etc or end of line.
+* `ignoreComplexTernaryConditions` (defaults to `false`): ignores complex ternary conditions - condition must contain `&&`, `||` etc. or end of line.
 
 #### SlevomatCodingStandard.PHP.UselessSemicolon 🔧
 

doc/type-hints.md

@@ -13,7 +13,7 @@ Sniff provides the following settings:
 
 #### SlevomatCodingStandard.TypeHints.DisallowArrayTypeHintSyntax 🔧
 
-Disallows usage of array type hint syntax (eg. `int[]`, `bool[][]`) in phpDocs in favour of generic type hint syntax (eg. `array<int>`, `array<array<bool>>`).
+Disallows usage of array type hint syntax (e.g. `int[]`, `bool[][]`) in phpDocs in favour of generic type hint syntax (eg. `array<int>`, `array<array<bool>>`).
 
 Sniff provides the following settings:
 
@@ -57,7 +57,7 @@ Sniff provides the following settings:
 * `enableUnionTypeHint`: enforces to transform `@param string|int` into native `string|int` typehint. It's on by default if you're on PHP 8.0+
 * `enableIntersectionTypeHint`: enforces to transform `@param Foo&Bar` into native `Foo&Bar` typehint. It's on by default if you're on PHP 8.1+
 * `enableStandaloneNullTrueFalseTypeHints`: enforces to transform `@param true`, `@param false` or `@param null` into native typehints. It's on by default if you're on PHP 8.2+
-* `traversableTypeHints`: enforces which typehints must have specified contained type. E. g. if you set this to `\Doctrine\Common\Collections\Collection`, then `\Doctrine\Common\Collections\Collection` must always be supplied with the contained type: `\Doctrine\Common\Collections\Collection|Foo[]`.
+* `traversableTypeHints`: enforces which typehints must have specified contained type. E.g. if you set this to `\Doctrine\Common\Collections\Collection`, then `\Doctrine\Common\Collections\Collection` must always be supplied with the contained type: `\Doctrine\Common\Collections\Collection|Foo[]`.
 
 This sniff can cause an error if you're overriding or implementing a parent method which does not have typehints. In such cases add `@phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint` annotation to the method to have this sniff skip it.
 
@@ -79,7 +79,7 @@ Sniff provides the following settings:
 * `enableUnionTypeHint`: enforces to transform `@var string|int` into native `string|int` typehint. It's on by default if you're on PHP 8.0+. It can be enabled only when `enableNativeTypeHint` is enabled too.
 * `enableIntersectionTypeHint`: enforces to transform `@var Foo&Bar` into native `Foo&Bar` typehint. It's on by default if you're on PHP 8.1+. It can be enabled only when `enableNativeTypeHint` is enabled too.
 * `enableStandaloneNullTrueFalseTypeHints`: enforces to transform `@var true`, `@var false` or `@var null` into native typehints. It's on by default if you're on PHP 8.2+. It can be enabled only when `enableNativeTypeHint` is enabled too.
-* `traversableTypeHints`: enforces which typehints must have specified contained type. E. g. if you set this to `\Doctrine\Common\Collections\Collection`, then `\Doctrine\Common\Collections\Collection` must always be supplied with the contained type: `\Doctrine\Common\Collections\Collection|Foo[]`.
+* `traversableTypeHints`: enforces which typehints must have specified contained type. E.g. if you set this to `\Doctrine\Common\Collections\Collection`, then `\Doctrine\Common\Collections\Collection` must always be supplied with the contained type: `\Doctrine\Common\Collections\Collection|Foo[]`.
 
 This sniff can cause an error if you're overriding parent property which does not have typehints. In such cases add `@phpcsSuppress SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint` annotation to the property to have this sniff skip it.
 
@@ -98,7 +98,7 @@ Sniff provides the following settings:
 * `enableIntersectionTypeHint`: enforces to transform `@return Foo&Bar` into native `Foo&Bar` typehint. It's on by default if you're on PHP 8.1+.
 * `enableNeverTypeHint`: enforces to transform `@return never` into native `never` typehint. It's on by default if you're on PHP 8.1+.
 * `enableStandaloneNullTrueFalseTypeHints`: enforces to transform `@return true`, `@return false` or `@return null` into native typehints. It's on by default if you're on PHP 8.2+.
-* `traversableTypeHints`: enforces which typehints must have specified contained type. E. g. if you set this to `\Doctrine\Common\Collections\Collection`, then `\Doctrine\Common\Collections\Collection` must always be supplied with the contained type: `\Doctrine\Common\Collections\Collection|Foo[]`.
+* `traversableTypeHints`: enforces which typehints must have specified contained type. E.g. if you set this to `\Doctrine\Common\Collections\Collection`, then `\Doctrine\Common\Collections\Collection` must always be supplied with the contained type: `\Doctrine\Common\Collections\Collection|Foo[]`.
 
 This sniff can cause an error if you're overriding or implementing a parent method which does not have typehints. In such cases add `@phpcsSuppress SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint` annotation to the method to have this sniff skip it.