From 043d16bcf8017372ea63f6a3d0fcaea1127daca9 Mon Sep 17 00:00:00 2001 From: Michael Rios Date: Wed, 8 Dec 2021 15:17:08 -0800 Subject: [PATCH] =?UTF-8?q?Update=20validator=20function=20name=20in=20=20?= =?UTF-8?q?examples=20to=20show=20that=20value=20must=20b=E2=80=A6=20(#332?= =?UTF-8?q?7)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update validator function name in examples to show that value must be bar vs must contain a space * Add md file in --- changes/3327-michaelrios28.md | 1 + docs/examples/models_errors2.py | 2 +- docs/examples/models_errors3.py | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 changes/3327-michaelrios28.md diff --git a/changes/3327-michaelrios28.md b/changes/3327-michaelrios28.md new file mode 100644 index 0000000..30aeb5b --- /dev/null +++ b/changes/3327-michaelrios28.md @@ -0,0 +1 @@ +Changed the validator method name in the [Custom Errors example](https://pydantic-docs.helpmanual.io/usage/models/#custom-errors) to more accurately describe what the validator is doing; changed from `name_must_contain_space` to ` value_must_equal_bar`. diff --git a/docs/examples/models_errors2.py b/docs/examples/models_errors2.py index 28c81e6..7aa1b15 100644 --- a/docs/examples/models_errors2.py +++ b/docs/examples/models_errors2.py @@ -5,7 +5,7 @@ class Model(BaseModel): foo: str @validator('foo') - def name_must_contain_space(cls, v): + def value_must_equal_bar(cls, v): if v != 'bar': raise ValueError('value must be "bar"') diff --git a/docs/examples/models_errors3.py b/docs/examples/models_errors3.py index 36ba646..32a34d6 100644 --- a/docs/examples/models_errors3.py +++ b/docs/examples/models_errors3.py @@ -10,7 +10,7 @@ class Model(BaseModel): foo: str @validator('foo') - def name_must_contain_space(cls, v): + def value_must_equal_bar(cls, v): if v != 'bar': raise NotABarError(wrong_value=v) return v