diff --git a/changes/3327-michaelrios28.md b/changes/3327-michaelrios28.md new file mode 100644 index 0000000000..30aeb5b4fd --- /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 28c81e6330..7aa1b15690 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 36ba646aa9..32a34d65ec 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