kennethreitz/pydantic
1
0
Fork 0
mirror of https://github.com/kennethreitz/pydantic.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify documentation and error message about keep_untouched (#926)

Browse Source 
* Clarify keep_untouched documentation (#924)

* Clarify error message for custom types (#924)

* Fix tests for changed error message (#924)

* fix formatting

* remove erroneous error message and add change
This commit is contained in:
retnikt
2019-10-23 11:14:51 +01:00
committed by Samuel Colvin
parent bab6970f12
commit dccc4014dc
4 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/usage/model_config.md
+2 -2
View File
@@ -62,8 +62,8 @@ Options:
: a callable that takes a field name and returns an alias for it
**`keep_untouched`**
: a tuple of types (e.g. descriptors) that should not be changed during model creation and will not be
included in the model schemas
: a tuple of types (e.g. descriptors) for a model's default values that should not be changed during model creation and will
not be included in the model schemas. **Note**: this means that attributes on the model with *defaults of this type*, not *annotations of this type*, will be left alone.
**`schema_extra`**
: a `dict` used to extend/update the generated JSON Schema