docs: fix linting errors

weierophinney · weierophinney · commit 0c38c7b539b5 · 2021-07-14T09:27:27.000-05:00
Signed-off-by: Matthew Weier O'Phinney &lt;matthew@weierophinney.net&gt;
diff --git a/docs/book/validators/barcode.md b/docs/book/validators/barcode.md
@@ -311,13 +311,13 @@ your own barcode validator, you need the following information.
 
 - `Length`: The length your barcode must have. It can have one of the following
   values:
-    - `Integer`: A value greater 0, which means that the barcode must have this
-      length.
-    - `-1`: There is no limitation for the length of this barcode.
-    - `"even"`: The length of this barcode must have a even amount of digits.
-    - `"odd"`: The length of this barcode must have a odd amount of digits.
-    - `array`: An array of integer values. The length of this barcode must have
-    one of the set array values.
+  - `Integer`: A value greater 0, which means that the barcode must have this
+    length.
+  - `-1`: There is no limitation for the length of this barcode.
+  - `"even"`: The length of this barcode must have a even amount of digits.
+  - `"odd"`: The length of this barcode must have a odd amount of digits.
+  - `array`: An array of integer values. The length of this barcode must have
+  one of the set array values.
 - `Characters`: A string which contains all allowed characters for this barcode.
   Also the integer value 128 is allowed, which means the first 128 characters of
   the ASCII table.
diff --git a/docs/book/validators/between.md b/docs/book/validators/between.md
@@ -3,6 +3,7 @@
 `Laminas\Validator\Between` allows you to validate if a given value is between two
 other values.
 
+<!-- markdownlint-disable-next-line MD001 -->
 > ### Only supports number validation
 >
 > `Laminas\Validator\Between` supports only the validation of numbers. Strings or
diff --git a/docs/book/validators/credit-card.md b/docs/book/validators/credit-card.md
@@ -35,6 +35,7 @@ The following issuing institutes are accepted:
 - Visa Electron
 - Russia Mir
 
+<!-- markdownlint-disable-next-line MD001 -->
 > ### Invalid institutes
 >
 > The institutes **Bankcard** and **Diners Club enRoute** no longer exist, and
diff --git a/docs/book/validators/csrf.md b/docs/book/validators/csrf.md
@@ -9,6 +9,7 @@ The typical mitigation is to create a one-time token that is transmitted as part
 This token expires after first submission or after a short amount of time, preventing replays or further submissions.
 If the token provided does not match what was originally sent, an error should be returned.
 
+<!-- markdownlint-disable-next-line MD001 -->
 > ### Installation Requirements
 >
 > The CSRF validator depends on [laminas-math](https://docs.laminas.dev/laminas-math/) to generate the hash and on [laminas-session](https://docs.laminas.dev/laminas-session/) to persist the generated token between requests.
diff --git a/docs/book/validators/db.md b/docs/book/validators/db.md
@@ -4,6 +4,7 @@
 a means to test whether a record exists in a given table of a database, with a
 given value.
 
+<!-- markdownlint-disable-next-line MD001 -->
 > ### Installation requirements
 >
 > `Laminas\Validator\Db\NoRecordExists` and `Laminas\Validator\Db\RecordExists`
diff --git a/docs/book/validators/digits.md b/docs/book/validators/digits.md
@@ -2,6 +2,7 @@
 
 `Laminas\Validator\Digits` validates if a given value contains only digits.
 
+<!-- markdownlint-disable-next-line MD001 -->
 > ### Installation requirements
 >
 > `Laminas\Validator\Digits` depends on the laminas-filter component, so be sure to
diff --git a/docs/book/validators/email-address.md b/docs/book/validators/email-address.md
@@ -34,11 +34,11 @@ using `setOptions()`. The following options are supported:
   in conjunction with the hostnameValidator option to set the hostname validator.
   Possible values of this option defined in [Hostname](hostname.md) validator's
   `ALLOW_*` constants:
-    - `ALLOW_DNS` (default) - Allows Internet domain names _(e.g. example.com)_
-    - `ALLOW_IP` - Allows IP addresses _(e.g. 192.168.0.1)_
-    - `ALLOW_LOCAL` - Allows local network such as _localhost_ or _www.localdomain_
-    - `ALLOW_URI`  - Allows hostnames in URI generic syntax. See [RFC 3986](https://www.ietf.org/rfc/rfc3986.txt)
-    - `ALLOW_ALL` - Allows all types of hostnames
+  - `ALLOW_DNS` (default) - Allows Internet domain names _(e.g. example.com)_
+  - `ALLOW_IP` - Allows IP addresses _(e.g. 192.168.0.1)_
+  - `ALLOW_LOCAL` - Allows local network such as _localhost_ or _www.localdomain_
+  - `ALLOW_URI`  - Allows hostnames in URI generic syntax. See [RFC 3986](https://www.ietf.org/rfc/rfc3986.txt)
+  - `ALLOW_ALL` - Allows all types of hostnames
 
 - `useDeepMxCheck`: Defines if the servers MX records should be verified by a deep check.
   When this option is set to `true` then additionally to MX records also the `A`,
@@ -54,7 +54,6 @@ using `setOptions()`. The following options are supported:
   option is defined to `true` then the MX records are used to verify if the
   server accepts emails. This option defaults to `false`.
 
-
 ## Complex local parts
 
 `Laminas\Validator\EmailAddress` will match any valid email address according to
diff --git a/docs/book/validators/greater-than.md b/docs/book/validators/greater-than.md
@@ -3,6 +3,7 @@
 `Laminas\Validator\GreaterThan` allows you to validate if a given value is greater
 than a minimum border value.
 
+<!-- markdownlint-disable-next-line MD001 -->
 > ### Only supports numbers
 >
 > `Laminas\Validator\GreaterThan` supports only the validation of numbers. Strings
diff --git a/docs/book/validators/hex.md b/docs/book/validators/hex.md
@@ -14,6 +14,7 @@ if ($validator->isValid('123ABC')) {
 }
 ```
 
+<!-- markdownlint-disable-next-line MD001 -->
 > ### Invalid characters
 >
 > All other characters will return false, including whitespace and decimal
diff --git a/docs/book/validators/in-array.md b/docs/book/validators/in-array.md
@@ -13,14 +13,14 @@ The following options are supported for `Laminas\Validator\InArray`:
 - `strict`: Three modes of comparison are offered owing to an often overlooked,
   and potentially dangerous security issue when validating string input from
   user input.
-    - `InArray::COMPARE_STRICT`: This is a normal `in_array()` strict comparison
-      that checks value and type.
-    - `InArray::COMPARE_NOT_STRICT`: This is a normal `in_array()` non-strict
-      comparison that checks value only, but not type.
-    - `InArray::COMPARE_NOT_STRICT_AND_PREVENT_STR_TO_INT_VULNERABILTY`: This
-      operates in essentially the same way as `InArray::COMPARE_NOT_STRICT`,
-      but ensures that strings are not cast to integer during comparison,
-      preventing `0 == 'foo43'` types of false positives.
+  - `InArray::COMPARE_STRICT`: This is a normal `in_array()` strict comparison
+    that checks value and type.
+  - `InArray::COMPARE_NOT_STRICT`: This is a normal `in_array()` non-strict
+    comparison that checks value only, but not type.
+  - `InArray::COMPARE_NOT_STRICT_AND_PREVENT_STR_TO_INT_VULNERABILTY`: This
+    operates in essentially the same way as `InArray::COMPARE_NOT_STRICT`,
+    but ensures that strings are not cast to integer during comparison,
+    preventing `0 == 'foo43'` types of false positives.
 
 > ### Use non-strict carefully
 >
diff --git a/docs/book/validators/isbn.md b/docs/book/validators/isbn.md
@@ -83,4 +83,5 @@ Valid separators include:
 
 - `` (empty) (default)
 - `-` (hyphen)
+<!-- markdownlint-disable-next-line MD038 -->
 - ` ` (space)
diff --git a/docs/book/validators/string-length.md b/docs/book/validators/string-length.md
@@ -3,6 +3,7 @@
 This validator allows you to validate if a given string is between a defined
 length.
 
+<!-- markdownlint-disable-next-line MD001 -->
 > ### Supports only string validation
 >
 > `Laminas\Validator\StringLength` supports only the validation of strings.
@@ -131,6 +132,7 @@ When your installation and your application are using different encodings, then
 you should always set an encoding manually.
 
 ## Validation Messages
+
 Using the setMessage() method you can set another message to be returned in case of the specified failure.
 
 ```php
diff --git a/docs/book/validators/undisclosed-password.md b/docs/book/validators/undisclosed-password.md
@@ -4,8 +4,9 @@
 
 `Laminas\Validator\UndisclosedPassword` allows you to validate if a given password was found in data breaches using the service [Have I Been Pwned?](https://www.haveibeenpwned.com), in a secure, anonymous way using [K-Anonymity](https://www.troyhunt.com/ive-just-launched-pwned-passwords-version-2) to ensure passwords are not send in full over the wire.
 
+<!-- markdownlint-disable-next-line MD001 -->
 > ### Installation requirements
-> 
+>
 > This validator needs to make a request over HTTP; therefore it requires an HTTP client. The validator provides support only for HTTP clients implementing [PSR-18](https://www.php-fig.org/psr/psr-18/) and [PSR-17](https://www.php-fig.org/psr/psr-17/) request and response factories.
 >
 > To ensure you have these installed before using this validator, run the following:
@@ -35,7 +36,7 @@ $validator = new Laminas\Validator\UndisclosedPassword(
 $result = $validator->isValid('password');
 // $result is FALSE because "password" was found in a data breach
 
-$result = $validator->isValid('8aDk=XiW2E.77tLfuAcB'); 
+$result = $validator->isValid('8aDk=XiW2E.77tLfuAcB');
 // $result is TRUE because "8aDk=XiW2E.77tLfuAcB" was not found in a data breach
 ```
 
diff --git a/docs/book/validators/uuid.md b/docs/book/validators/uuid.md
@@ -17,6 +17,7 @@ The `Uuid` validator is capable of validating whether a string is a valid UUID
 of any version. It does not validate that the UUID exists in your system,
 however, only that it is well-formed.
 
+<!-- markdownlint-disable-next-line MD001 -->
 > ### Introduced in 2.8.0
 >
 > `Laminas\Validator\Uuid` was introduced with version 2.8.0.

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`Laminas\Validator\Between` allows you to validate if a given value is between two
`4`	`4`	`other values.`
`5`	`5`
	`6`	`+<!-- markdownlint-disable-next-line MD001 -->`
`6`	`7`	`> ### Only supports number validation`
`7`	`8`	`>`
`8`	`9`	> `Laminas\Validator\Between` supports only the validation of numbers. Strings or
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ The following issuing institutes are accepted:`
`35`	`35`	`- Visa Electron`
`36`	`36`	`- Russia Mir`
`37`	`37`
	`38`	`+<!-- markdownlint-disable-next-line MD001 -->`
`38`	`39`	`> ### Invalid institutes`
`39`	`40`	`>`
`40`	`41`	`> The institutes Bankcard and Diners Club enRoute no longer exist, and`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ The typical mitigation is to create a one-time token that is transmitted as part`
`9`	`9`	`This token expires after first submission or after a short amount of time, preventing replays or further submissions.`
`10`	`10`	`If the token provided does not match what was originally sent, an error should be returned.`
`11`	`11`
	`12`	`+<!-- markdownlint-disable-next-line MD001 -->`
`12`	`13`	`> ### Installation Requirements`
`13`	`14`	`>`
`14`	`15`	`> The CSRF validator depends on [laminas-math](https://docs.laminas.dev/laminas-math/) to generate the hash and on [laminas-session](https://docs.laminas.dev/laminas-session/) to persist the generated token between requests.`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`a means to test whether a record exists in a given table of a database, with a`
`5`	`5`	`given value.`
`6`	`6`
	`7`	`+<!-- markdownlint-disable-next-line MD001 -->`
`7`	`8`	`> ### Installation requirements`
`8`	`9`	`>`
`9`	`10`	> `Laminas\Validator\Db\NoRecordExists` and `Laminas\Validator\Db\RecordExists`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`Laminas\Validator\Digits` validates if a given value contains only digits.
`4`	`4`
	`5`	`+<!-- markdownlint-disable-next-line MD001 -->`
`5`	`6`	`> ### Installation requirements`
`6`	`7`	`>`
`7`	`8`	> `Laminas\Validator\Digits` depends on the laminas-filter component, so be sure to
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`Laminas\Validator\GreaterThan` allows you to validate if a given value is greater
`4`	`4`	`than a minimum border value.`
`5`	`5`
	`6`	`+<!-- markdownlint-disable-next-line MD001 -->`
`6`	`7`	`> ### Only supports numbers`
`7`	`8`	`>`
`8`	`9`	> `Laminas\Validator\GreaterThan` supports only the validation of numbers. Strings
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ if ($validator->isValid('123ABC')) {`
`14`	`14`	`}`
`15`	`15`	```
`16`	`16`
	`17`	`+<!-- markdownlint-disable-next-line MD001 -->`
`17`	`18`	`> ### Invalid characters`
`18`	`19`	`>`
`19`	`20`	`> All other characters will return false, including whitespace and decimal`