Documentation cleanup

Author: kukulich

doc/arrays.md

@@ -31,7 +31,7 @@ Checks whitespace in single line array declarations (whitespace between brackets
 Sniff provides the following settings:
 
 * `spacesAroundBrackets`: number of spaces you require to have around array brackets
-* `enableEmptyArrayCheck` (defaults to `false`): enables check for empty arrays
+* `enableEmptyArrayCheck` (default: `false`): enables check for empty arrays
 
 #### SlevomatCodingStandard.Arrays.TrailingArrayComma 🔧
 

doc/attributes.md

@@ -6,7 +6,7 @@ Sniff checks lines count between attribute and its target (or target's documenta
 
 Sniff provides the following settings:
 
-* `allowOnSameLine`: allow attribute and its target to be placed on the same line (default value is false)
+* `allowOnSameLine` (default: `false`): allow attribute and its target to be placed on the same line
 * `linesCount`: lines count between attribute and its target
 
 #### SlevomatCodingStandard.Attributes.AttributesOrder 🔧

doc/classes.md

@@ -26,9 +26,9 @@ public const BAR = 2; // correct
 
 Disallows long classes. This sniff provides the following settings:
 
-* `includeComments`: should comments be included in the count (default value is false).
-* `includeWhitespace`: should empty lines be included in the count (default value is false).
-* `maxLinesLength`: specifies max allowed function lines length (default value is 250).
+* `includeComments` (default: `false`): should comments be included in the count.
+* `includeWhitespace` (default: `false`): should empty lines be included in the count.
+* `maxLinesLength` (default: `250`): specifies max allowed function lines length.
 
 #### SlevomatCodingStandard.Classes.ClassMemberSpacing 🔧
 
@@ -142,8 +142,8 @@ Disallows using public properties.
 
 This sniff provides the following setting:
 
-* `checkPromoted`: will check promoted properties too.
-* `allowReadonly`: will allow readonly properties (default value is false).
+* `checkPromoted` (default: `false`): will check promoted properties too.
+* `allowReadonly` (default: `false`): will allow readonly properties.
 
 #### SlevomatCodingStandard.Classes.MethodSpacing 🔧
 

doc/complexity.md

@@ -6,5 +6,5 @@ Enforces maximum [cognitive complexity](https://www.sonarsource.com/docs/Cogniti
 
 Sniff provides the following setting:
 
-* `warningThreshold`: defaults to 6
-* `errorThreshold` : defaults to 6
+* `warningThreshold` (default: `6`)
+* `errorThreshold` (default: `6`)

doc/control-structures.md

@@ -184,8 +184,8 @@ Ternary operator has to be reformatted to more lines when the line length exceed
 
 Sniff provides the following settings:
 
-* `lineLengthLimit` (defaults to `0`)
-* `minExpressionsLength` (defaults to `null`): when the expressions after `?` are shorter than this length, the ternary operator does not have to be reformatted.
+* `lineLengthLimit` (default: `0`)
+* `minExpressionsLength` (default: `null`): when the expressions after `?` are shorter than this length, the ternary operator does not have to be reformatted.
 
 #### SlevomatCodingStandard.ControlStructures.RequireNullCoalesceEqualOperator 🔧
 
@@ -226,7 +226,7 @@ Requires ternary operator when possible.
 
 Sniff provides the following settings:
 
-* `ignoreMultiLine` (defaults to `false`): ignores multi-line statements.
+* `ignoreMultiLine` (default: `false`): ignores multi-line statements.
 
 #### SlevomatCodingStandard.ControlStructures.DisallowYodaComparison 🔧
 #### SlevomatCodingStandard.ControlStructures.RequireYodaComparison 🔧
@@ -235,7 +235,7 @@ Sniff provides the following settings:
 
 Sniff provides the following settings:
 
-* `alwaysVariableOnRight` (defaults to `false`): moves variables always to right.
+* `alwaysVariableOnRight` (default: `false`): moves variables always to right.
 
 `DisallowYodaComparison` looks for and fixes such comparisons not only in `if` statements but in the whole code.
 
@@ -247,12 +247,12 @@ Reports useless conditions where both branches return `true` or `false`.
 
 Sniff provides the following settings:
 
-* `assumeAllConditionExpressionsAreAlreadyBoolean` (defaults to `false`).
+* `assumeAllConditionExpressionsAreAlreadyBoolean` (default: `false`).
 
 #### SlevomatCodingStandard.ControlStructures.UselessTernaryOperator 🔧
 
 Reports useless ternary operator where both branches return `true` or `false`.
 
 Sniff provides the following settings:
 
-* `assumeAllConditionExpressionsAreAlreadyBoolean` (defaults to `false`).
+* `assumeAllConditionExpressionsAreAlreadyBoolean` (default: `false`).

doc/files.md

@@ -4,9 +4,9 @@
 
 Disallows long files. This sniff provides the following settings:
 
-* `includeComments`: should comments be included in the count (default value is false).
-* `includeWhitespace`: should empty lines be included in the count (default value is false).
-* `maxLinesLength`: specifies max allowed function lines length (default value is 250).
+* `includeComments` (default: `false`): should comments be included in the count.
+* `includeWhitespace` (default: `false`): should empty lines be included in the count.
+* `maxLinesLength` (default: `250`): specifies max allowed function lines length.
 
 #### SlevomatCodingStandard.Files.LineLength
 

doc/functions.md

@@ -23,17 +23,17 @@ Reports empty functions body and requires at least a comment inside.
 
 Disallows long functions. This sniff provides the following setting:
 
-* `includeComments`: should comments be included in the count (default value is false).
-* `includeWhitespace`: should empty lines be included in the count (default value is false).
-* `maxLinesLength`: specifies max allowed function lines length (default value is 20).
+* `includeComments` (default: `false`): should comments be included in the count.
+* `includeWhitespace` (default: `false`): should empty lines be included in the count.
+* `maxLinesLength` (default: `20`): specifies max allowed function lines length.
 
 #### SlevomatCodingStandard.Functions.RequireArrowFunction 🔧
 
 Requires arrow functions.
 
 Sniff provides the following settings:
 
-* `allowNested` (defaults to `true`)
+* `allowNested` (default: `true`)
 * `enable`: either to enable or not this sniff. By default, it is enabled for PHP versions 7.4 or higher.
 
 #### SlevomatCodingStandard.Functions.RequireMultiLineCall 🔧
@@ -51,7 +51,7 @@ Enforces function call to be on a single line.
 Sniff provides the following settings:
 
 * `maxLineLength`: specifies max allowed line length. If call would fit on it, it's enforced. Use 0 value to enforce for all calls, regardless of length.
-* `ignoreWithComplexParameter` (defaults to `true`): ignores calls with arrays, closures, arrow functions and nested calls.
+* `ignoreWithComplexParameter` (default: `true`): ignores calls with arrays, closures, arrow functions and nested calls.
 
 #### SlevomatCodingStandard.Functions.DisallowNamedArguments
 

doc/namespaces.md

@@ -16,7 +16,7 @@ use LogStandard;
 Sniff provides the following settings:
 
 
-* `psr12Compatible` (defaults to `true`): sets the required order to `classes`, `functions` and `constants`. `false` sets the required order to `classes`, `constants` and `functions`.
+* `psr12Compatible` (default: `true`): sets the required order to `classes`, `functions` and `constants`. `false` sets the required order to `classes`, `constants` and `functions`.
 * `caseSensitive`: compare namespaces case sensitively, which makes this order correct:
 
 ```php
@@ -117,7 +117,7 @@ Requires only one namespace in a file.
 
 Sniff provides the following settings:
 
-* `searchAnnotations` (defaults to `false`): enables searching for mentions in annotations.
+* `searchAnnotations` (default: `false`): enables searching for mentions in annotations.
 * `namespacesRequiredToUse`: if not set, all namespaces are required to be used. When set, only mentioned namespaces are required to be used. Useful in tandem with UseOnlyWhitelistedNamespaces sniff.
 * `allowFullyQualifiedExceptions`, `specialExceptionNames` & `ignoredNames`: allows fully qualified exceptions. Useful in tandem with FullyQualifiedExceptions sniff.
 * `allowFullyQualifiedNameForCollidingClasses`: allow fully qualified name for a class with a colliding use statement.
@@ -181,6 +181,6 @@ Looks for unused imports from other namespaces.
 
 Sniff provides the following settings:
 
-* `searchAnnotations` (defaults to `false`): enables searching for class names in annotations.
+* `searchAnnotations` (default: `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.

doc/php.md

@@ -46,8 +46,8 @@ Requires assertion via `assert` instead of inline documentation comments.
 
 Sniff provides the following settings:
 
-* `enableIntegerRanges` (defaults to `false`): enables support for `positive-int`, `negative-int` and `int<0, 100>`.
-* `enableAdvancedStringTypes` (defaults to `false`): enables support for `callable-string`, `numeric-string` and `non-empty-string`.
+* `enableIntegerRanges` (default: `false`): enables support for `positive-int`, `negative-int` and `int<0, 100>`.
+* `enableAdvancedStringTypes` (default: `false`): enables support for `callable-string`, `numeric-string` and `non-empty-string`.
 
 #### SlevomatCodingStandard.PHP.RequireNowdoc 🔧
 
@@ -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` (default: `false`): ignores complex ternary conditions - condition must contain `&&`, `||` etc. or end of line.
 
 #### SlevomatCodingStandard.PHP.UselessSemicolon 🔧
 

doc/variables.md

@@ -18,7 +18,7 @@ Looks for unused variables.
 
 Sniff provides the following settings:
 
-* `ignoreUnusedValuesWhenOnlyKeysAreUsedInForeach` (defaults to `false`): ignore unused `$value` in foreach when only `$key` is used
+* `ignoreUnusedValuesWhenOnlyKeysAreUsedInForeach` (default: `false`): ignore unused `$value` in foreach when only `$key` is used
 
 ```php
 foreach ($values as $key => $value) {