Added a note about the usage of NotBlank

javiereguiluz · javiereguiluz · commit 24ed17e4dfc1 · 2018-09-28T15:24:08.000+02:00
diff --git a/reference/constraints/Bic.rst b/reference/constraints/Bic.rst
@@ -83,6 +83,8 @@ will contain a Business Identifier Code (BIC).
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Available Options
 -----------------
 
diff --git a/reference/constraints/CardScheme.rst b/reference/constraints/CardScheme.rst
@@ -96,6 +96,8 @@ on an object that will contain a credit card number.
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Available Options
 -----------------
 
diff --git a/reference/constraints/Country.rst b/reference/constraints/Country.rst
@@ -73,6 +73,8 @@ Basic Usage
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Currency.rst b/reference/constraints/Currency.rst
@@ -79,6 +79,8 @@ a valid currency, you could do the following:
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Date.rst b/reference/constraints/Date.rst
@@ -75,6 +75,8 @@ Basic Usage
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/DateTime.rst b/reference/constraints/DateTime.rst
@@ -75,6 +75,8 @@ Basic Usage
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Email.rst b/reference/constraints/Email.rst
@@ -88,6 +88,8 @@ Basic Usage
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/File.rst b/reference/constraints/File.rst
@@ -150,6 +150,8 @@ The ``bioFile`` property is validated to guarantee that it is a real file.
 Its size and mime type are also validated because the appropriate options
 have been specified.
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Iban.rst b/reference/constraints/Iban.rst
@@ -93,6 +93,8 @@ will contain an International Bank Account Number.
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Available Options
 -----------------
 
diff --git a/reference/constraints/Ip.rst b/reference/constraints/Ip.rst
@@ -76,6 +76,8 @@ Basic Usage
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Isbn.rst b/reference/constraints/Isbn.rst
@@ -104,6 +104,8 @@ on an object that will contain an ISBN.
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Available Options
 -----------------
 
diff --git a/reference/constraints/Issn.rst b/reference/constraints/Issn.rst
@@ -79,6 +79,8 @@ Basic Usage
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Language.rst b/reference/constraints/Language.rst
@@ -74,6 +74,8 @@ Basic Usage
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Length.rst b/reference/constraints/Length.rst
@@ -110,6 +110,8 @@ and "50", you might add the following:
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Locale.rst b/reference/constraints/Locale.rst
@@ -78,6 +78,8 @@ Basic Usage
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Luhn.rst b/reference/constraints/Luhn.rst
@@ -85,6 +85,8 @@ will contain a credit card number.
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Available Options
 -----------------
 
diff --git a/reference/constraints/Regex.rst b/reference/constraints/Regex.rst
@@ -161,6 +161,8 @@ it a custom message:
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Time.rst b/reference/constraints/Time.rst
@@ -78,6 +78,8 @@ of the day when the event starts:
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Url.rst b/reference/constraints/Url.rst
@@ -76,6 +76,8 @@ Basic Usage
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/Uuid.rst b/reference/constraints/Uuid.rst
@@ -78,6 +78,8 @@ Basic Usage
             }
         }
 
+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc
+
 Options
 -------
 
diff --git a/reference/constraints/_empty-values-are-valid.rst.inc b/reference/constraints/_empty-values-are-valid.rst.inc
@@ -0,0 +1,7 @@
+.. note::
+
+    As with most of the other constraints, ``null`` values and empty strings
+    are considered valid values. Otherwise, in addition to validating this value,
+    you would also be requiring it, making it impossible to be optional. That's
+    why it's common to combine this constraint with
+    :doc:`NotBlank </reference/constraints/NotBlank>`.

Original file line number	Diff line number	Diff line change
`@@ -83,6 +83,8 @@ will contain a Business Identifier Code (BIC).`
`83`	`83`	`}`
`84`	`84`	`}`
`85`	`85`
	`86`	`+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc`
	`87`	`+`
`86`	`88`	`Available Options`
`87`	`89`	`-----------------`
`88`	`90`
Original file line number	Diff line number	Diff line change
`@@ -96,6 +96,8 @@ on an object that will contain a credit card number.`
`96`	`96`	`}`
`97`	`97`	`}`
`98`	`98`
	`99`	`+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc`
	`100`	`+`
`99`	`101`	`Available Options`
`100`	`102`	`-----------------`
`101`	`103`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,8 @@ Basic Usage`
`73`	`73`	`}`
`74`	`74`	`}`
`75`	`75`
	`76`	`+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc`
	`77`	`+`
`76`	`78`	`Options`
`77`	`79`	`-------`
`78`	`80`
Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,8 @@ a valid currency, you could do the following:`
`79`	`79`	`}`
`80`	`80`	`}`
`81`	`81`
	`82`	`+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc`
	`83`	`+`
`82`	`84`	`Options`
`83`	`85`	`-------`
`84`	`86`
Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,8 @@ Basic Usage`
`75`	`75`	`}`
`76`	`76`	`}`
`77`	`77`
	`78`	`+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc`
	`79`	`+`
`78`	`80`	`Options`
`79`	`81`	`-------`
`80`	`82`
Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,8 @@ Basic Usage`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`
	`91`	`+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc`
	`92`	`+`
`91`	`93`	`Options`
`92`	`94`	`-------`
`93`	`95`
Original file line number	Diff line number	Diff line change
`@@ -93,6 +93,8 @@ will contain an International Bank Account Number.`
`93`	`93`	`}`
`94`	`94`	`}`
`95`	`95`
	`96`	`+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc`
	`97`	`+`
`96`	`98`	`Available Options`
`97`	`99`	`-----------------`
`98`	`100`
Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,8 @@ Basic Usage`
`76`	`76`	`}`
`77`	`77`	`}`
`78`	`78`
	`79`	`+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc`
	`80`	`+`
`79`	`81`	`Options`
`80`	`82`	`-------`
`81`	`83`
Original file line number	Diff line number	Diff line change
`@@ -104,6 +104,8 @@ on an object that will contain an ISBN.`
`104`	`104`	`}`
`105`	`105`	`}`
`106`	`106`
	`107`	`+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc`
	`108`	`+`
`107`	`109`	`Available Options`
`108`	`110`	`-----------------`
`109`	`111`
Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,8 @@ Basic Usage`
`79`	`79`	`}`
`80`	`80`	`}`
`81`	`81`
	`82`	`+.. include:: /reference/constraints/_empty-values-are-valid.rst.inc`
	`83`	`+`
`82`	`84`	`Options`
`83`	`85`	`-------`
`84`	`86`