Skip to content

Commit 404b897

Browse files
gsteelgsteel
authored
Merge pull request #392 from gsteel/md-lint-fixes
Markdown Linting Fixes
2 parents 57e95de + c5711fb commit 404b897

File tree

8 files changed

+24
-37
lines changed

8 files changed

+24
-37
lines changed

‎docs/book/index.md‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/book/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../README.md

‎docs/book/v2/validators/file/crc32.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ contents matches the supplied crc32 hash(es). It is subclassed from the [Hash
55
validator](hash.md) to provide a validator that only supports the `crc32`
66
algorithm.
77

8-
> ### Requires the hash extension
9-
>
10-
> This validator requires the PHP [Hash extension](http://php.net/hash) with the
11-
> `crc32` algorithm.
8+
MISSING: **Requires the hash extension**
9+
This validator requires the PHP [Hash extension](http://php.net/hash) with the `crc32` algorithm.
1210

1311
## Supported Options
1412

‎docs/book/v2/validators/file/hash.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,9 @@
33
`Laminas\Validator\File\Hash` allows you to validate if a given file's hashed
44
contents matches the supplied hash(es) and algorithm(s).
55

6-
> ### Requires the hash extension
7-
>
8-
> This validator requires the PHP [Hash extension](http://php.net/hash). A list
9-
> of supported hash algorithms can be found with the
10-
> [hash\_algos() function](http://php.net/hash_algos).
6+
MISSING: **Requires the hash extension**
7+
This validator requires the PHP [Hash extension](http://php.net/hash)
8+
A list of supported hash algorithms can be found with the [hash_algos() function](http://php.net/hash_algos).
119

1210
## Supported Options
1311

‎docs/book/v2/validators/file/intro.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ uploaded files, such as file size validation and CRC checking.
2323
- [UploadFile](upload-file.md)
2424
- [WordCount](word-count.md)
2525

26-
> ### Validation argument
27-
>
28-
> All of the File validators' `isValid()` methods support both a file path
29-
> `string` *or* a `$_FILES` array as the supplied argument. When a `$_FILES`
30-
> array is passed in, the `tmp_name` is used for the file path.
26+
NOTE: **Validation argument**
27+
All the File validators' `isValid()` methods support both a file path `string` *or* a `$_FILES` array as the supplied argument.
28+
When a `$_FILES` array is passed in, the `tmp_name` is used for the file path.

‎docs/book/v2/validators/file/md5.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ contents matches the supplied md5 hash(es). It is subclassed from the
55
[Hash validator](hash.md) to provide a validator that supports only the MD5
66
algorithm.
77

8-
> ### Requires the hash extension
9-
>
10-
> This validator requires the PHP [Hash extension](http://php.net/hash) PHP with
11-
> the `md5` algorithm.
8+
MISSING: **Requires the hash extension**
9+
This validator requires the PHP [Hash extension](http://php.net/hash) with the `md5` algorithm.
1210

1311
## Supported Options
1412

‎docs/book/v2/validators/file/mime-type.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,13 @@
66
This validator is inversely related to the
77
[ExcludeMimeType validator](exclude-mime-type.md)
88

9-
> ### Compatibility
10-
>
11-
> This component will use the `FileInfo` extension if it is available. If it's
12-
> not, it will degrade to the `mime_content_type()` function. And if the
13-
> function call fails, it will use the MIME type which is given by HTTP. You
14-
> should be aware of possible security problems when you do not have `FileInfo`
15-
> or `mime_content_type()` available; the MIME type given by HTTP is not secure
16-
> and can be easily manipulated.
9+
CAUTION: **Compatibility**
10+
This component will use the `FileInfo` extension if it is available. If it's
11+
not, it will degrade to the `mime_content_type()` function. And if the
12+
function call fails, it will use the MIME type which is given by HTTP. You
13+
should be aware of possible security problems when you do not have `FileInfo`
14+
or `mime_content_type()` available; the MIME type given by HTTP is not secure
15+
and can be easily manipulated.
1716

1817
## Supported Options
1918

‎docs/book/v2/validators/file/sha1.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ contents matches the supplied sha1 hash(es). It is subclassed from the
55
[Hash validator](hash.md) to provide a validator that only supports the `sha1`
66
algorithm.
77

8-
> ### Requires the hash extension
9-
>
10-
> This validator requires the PHP [Hash extension](http://php.net/hash) with the
11-
> `sha1` algorithm.
8+
MISSING: **Requires the hash extension**
9+
This validator requires the PHP [Hash extension](http://php.net/hash) with the `sha1` algorithm.
1210

1311
## Supported Options
1412

‎docs/book/v3/messages.md‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,12 @@ $translator->addTranslationFilePattern(
7272
AbstractValidator::setDefaultTranslator($translator);
7373
```
7474

75-
> ### Supported Languages
75+
> NOTE: **Supported Languages**
76+
> The supported languages may not be complete.
77+
> New languages will be added with each release.
78+
> Additionally, feel free to use the existing resource files to make your own translations.
7679
>
77-
> The supported languages may not be complete. New languages will be added with
78-
> each release. Additionally feel free to use the existing resource files to
79-
> make your own translations.
80-
>
81-
> You could also use these resource files to rewrite existing translations. So
82-
> you are not in need to create these files manually yourself.
80+
> You could also use these resource files to rewrite existing translations, so you don't have to create these files manually yourself.
8381
8482
## Limit the Size of a Validation Message
8583

0 commit comments

Comments
 (0)