diff options
author | Julian Berman <Julian@GrayVines.com> | 2017-12-24 15:09:48 -0500 |
---|---|---|
committer | Julian Berman <Julian@GrayVines.com> | 2017-12-24 15:09:48 -0500 |
commit | 11cfa509b6eb49baf80175917543a22498fd41da (patch) | |
tree | a61609a088b83415ebd42b29c2ade0cf4669c356 /docs/errors.rst | |
parent | 29bc69ef63d3dc2129fa7606228d69bbed7fb8d0 (diff) | |
download | jsonschema-11cfa509b6eb49baf80175917543a22498fd41da.tar.gz |
:func:
Diffstat (limited to 'docs/errors.rst')
-rw-r--r-- | docs/errors.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/errors.rst b/docs/errors.rst index 60e5a7d..ddbca82 100644 --- a/docs/errors.rst +++ b/docs/errors.rst @@ -342,7 +342,7 @@ corresponding validation error. best_match and relevance ------------------------ -The :func:`best_match` function is a simple but useful function for attempting +The `best_match` function is a simple but useful function for attempting to guess the most relevant error in a given bunch. .. doctest:: @@ -376,7 +376,7 @@ to guess the most relevant error in a given bunch. (i.e. from different instances or schemas), since it won't produce sensical output. :argument callable key: the key to use when sorting errors. See - `relevance` and transitively :func:`by_relevance` for more + `relevance` and transitively `by_relevance` for more details (the default is to sort with the defaults of that function). Changing the default is only useful if you want to change the function that rates errors but still want the error context descent done by @@ -395,7 +395,7 @@ to guess the most relevant error in a given bunch. If you want to sort a bunch of errors entirely, you can use this function to do so. Using this function as a key to e.g. - :func:`sorted` or :func:`max` will cause more relevant errors to be + `sorted` or `max` will cause more relevant errors to be considered greater than less relevant ones. Within the different validators that can fail, this function @@ -404,7 +404,7 @@ to guess the most relevant error in a given bunch. the same level in the instance. If you want to change the set of weak [or strong] validators you can create - a custom version of this function with :func:`by_relevance` and provide a + a custom version of this function with `by_relevance` and provide a different set of each. .. doctest:: |