diff options
| author | Sonny <samson.shi@capitalone.com> | 2018-04-16 13:59:21 -0400 |
|---|---|---|
| committer | Sonny <samson.shi@capitalone.com> | 2018-04-16 13:59:21 -0400 |
| commit | db2f3f933972690e6ff31a038559737d4535d81e (patch) | |
| tree | ecede9d0618496601eca9e1e0c5b244d752f6f11 /docs/validate.rst | |
| parent | 27eafe851370f3fc81453de518dace67ca313293 (diff) | |
| download | jsonschema-db2f3f933972690e6ff31a038559737d4535d81e.tar.gz | |
add clarification on validating with format checkers
Diffstat (limited to 'docs/validate.rst')
| -rw-r--r-- | docs/validate.rst | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/validate.rst b/docs/validate.rst index 9914cb4..3fade1a 100644 --- a/docs/validate.rst +++ b/docs/validate.rst @@ -39,7 +39,9 @@ classes should adhere to. whose `FormatChecker.conforms` method will be called to check and see if instances conform to each :validator:`format` property present in the schema. If unprovided, no validation - will be done for :validator:`format`. + will be done for :validator:`format`. Certain formats require + additional packages to be installed (ipv5, uri, color, date-time). + The required packages can be found at the bottom of this page. :argument types: .. deprecated:: 2.7.0 @@ -314,6 +316,10 @@ to validate. Their names can be viewed by inspecting the available if an appropriate package is available for use. The available checkers, along with their requirement (if any,) are listed below. +*Note*: If the following packages are not installed when using checkers +that require additional packages, validation will pass without throwing +an error. + ========== ==================== Checker Notes ========== ==================== |