Skip to content

Markdown Linting Fixes #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/book/index.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/book/index.md
6 changes: 2 additions & 4 deletions docs/book/v2/validators/file/crc32.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@ contents matches the supplied crc32 hash(es). It is subclassed from the [Hash
validator](hash.md) to provide a validator that only supports the `crc32`
algorithm.

> ### Requires the hash extension
>
> This validator requires the PHP [Hash extension](http://php.net/hash) with the
> `crc32` algorithm.
MISSING: **Requires the hash extension**
This validator requires the PHP [Hash extension](http://php.net/hash) with the `crc32` algorithm.

## Supported Options

Expand Down
8 changes: 3 additions & 5 deletions docs/book/v2/validators/file/hash.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@
`Laminas\Validator\File\Hash` allows you to validate if a given file's hashed
contents matches the supplied hash(es) and algorithm(s).

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

## Supported Options

Expand Down
8 changes: 3 additions & 5 deletions docs/book/v2/validators/file/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ uploaded files, such as file size validation and CRC checking.
- [UploadFile](upload-file.md)
- [WordCount](word-count.md)

> ### Validation argument
>
> All of the File validators' `isValid()` methods support both a file path
> `string` *or* a `$_FILES` array as the supplied argument. When a `$_FILES`
> array is passed in, the `tmp_name` is used for the file path.
NOTE: **Validation argument**
All the File validators' `isValid()` methods support both a file path `string` *or* a `$_FILES` array as the supplied argument.
When a `$_FILES` array is passed in, the `tmp_name` is used for the file path.
6 changes: 2 additions & 4 deletions docs/book/v2/validators/file/md5.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@ contents matches the supplied md5 hash(es). It is subclassed from the
[Hash validator](hash.md) to provide a validator that supports only the MD5
algorithm.

> ### Requires the hash extension
>
> This validator requires the PHP [Hash extension](http://php.net/hash) PHP with
> the `md5` algorithm.
MISSING: **Requires the hash extension**
This validator requires the PHP [Hash extension](http://php.net/hash) with the `md5` algorithm.

## Supported Options

Expand Down
15 changes: 7 additions & 8 deletions docs/book/v2/validators/file/mime-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,13 @@
This validator is inversely related to the
[ExcludeMimeType validator](exclude-mime-type.md)

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

## Supported Options

Expand Down
6 changes: 2 additions & 4 deletions docs/book/v2/validators/file/sha1.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@ contents matches the supplied sha1 hash(es). It is subclassed from the
[Hash validator](hash.md) to provide a validator that only supports the `sha1`
algorithm.

> ### Requires the hash extension
>
> This validator requires the PHP [Hash extension](http://php.net/hash) with the
> `sha1` algorithm.
MISSING: **Requires the hash extension**
This validator requires the PHP [Hash extension](http://php.net/hash) with the `sha1` algorithm.

## Supported Options

Expand Down
12 changes: 5 additions & 7 deletions docs/book/v3/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,12 @@ $translator->addTranslationFilePattern(
AbstractValidator::setDefaultTranslator($translator);
```

> ### Supported Languages
> NOTE: **Supported Languages**
> The supported languages may not be complete.
> New languages will be added with each release.
> Additionally, feel free to use the existing resource files to make your own translations.
>
> The supported languages may not be complete. New languages will be added with
> each release. Additionally feel free to use the existing resource files to
> make your own translations.
>
> You could also use these resource files to rewrite existing translations. So
> you are not in need to create these files manually yourself.
> You could also use these resource files to rewrite existing translations, so you don't have to create these files manually yourself.

## Limit the Size of a Validation Message

Expand Down