From 6c9cfeca1255c44b1a615b53239c92d0d923ac43 Mon Sep 17 00:00:00 2001
From: EduardoRoblesCh <58334436+EduardoRoblesCh@users.noreply.github.com>
Date: Sat, 5 Sep 2020 09:29:53 -0500
Subject: [PATCH] Update required-optional.md

There is a terrible mistake in this file!!!
In `required` method, the third parameter (`allowEmpty`) is false by default:

```php
public function required($key, $name = null, $allowEmpty = false)
```
And in the `optional method` is the opposite, `allowEmpty` is true by default:
```php
public function optional($key, $name = null, $allowEmpty = true)
```

And this page is explaining exactly the opposite!!
---
 docs/required-optional.md | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/docs/required-optional.md b/docs/required-optional.md
index c4f1fac..8a609c5 100644
--- a/docs/required-optional.md
+++ b/docs/required-optional.md
@@ -3,7 +3,8 @@
 `Required` and `optional` are special cases within Particle\Validator. Both `required`
 and `optional` will only check on the existence of the **key**, not the value. You can 
 check on a value being set with "allowEmpty", which is the third parameter to both the
-`required` as the `optional` methods (and false by default).
+`required` as the `optional` methods (and false by default in `required` method, and
+true by default in `optional` method).
 
 ## Examples in code
 
@@ -23,23 +24,23 @@ $v->required('foo', 'foo', true); // third parameter is "allowEmpty".
 $v->validate(['foo' => ''])->isValid(); // true, because allowEmpty is true.
 ```
 
-### Validate an optional value, which is not allowed to be empty
+### Validate an optional value, which is allowed to be empty by default
 
 ```php
 $v->optional('foo')->lengthBetween(0, 100);
-$v->validate(['foo' => ''])->isValid(); // false, because allowEmpty is false and the key exists.
+$v->validate(['foo' => ''])->isValid(); // true, because allowEmpty is true by default.
 ```
 
-### Validate a non-existing optional value, which is not allowed to be empty
+### Validate a non-existing optional value, which is allowed to be empty by default
 
 ```php
 $v->optional('foo')->lengthBetween(20, 100);
 $v->validate([])->isValid(); // true, because the optional key is not present.
 ```
 
-### Validate an optional value, which is allowed to be empty.
+### Validate an optional value, which is not allowed to be empty.
 
 ```php
-$v->optional('foo', 'foo', true)->lengthBetween(0, 100);
-$v->validate(['foo' => ''])->isValid(); // true, because allowEmpty is true.
+$v->optional('foo', 'foo', false)->lengthBetween(0, 100);
+$v->validate(['foo' => ''])->isValid(); // false, because allowEmpty is false.
 ```