Add documentation.

This commit is contained in:
Amos Latteier
2014-04-14 15:28:49 -04:00
parent ccb87e5cd6
commit 8383eb894c
3 changed files with 14 additions and 1 deletions

View File

@@ -26,6 +26,15 @@ Features
- Allow localization of error messages returned by ``colander.Invalid.asdict``
by adding an optional ``translate`` callable argument.
Backwards Incompatibilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~
- ``SchemaNode.deserialize`` will now raise an
``UnboundDeferredError`` if the node has an unbound deferred
validator. Previously, deferred validators were silently ignored.
See https://github.com/Pylons/colander/issues/47
1.0b1 (2013-09-01)
------------------

View File

@@ -48,6 +48,9 @@ Exceptions
from a widget as the value which should be redisplayed when an
error is shown.
.. autoclass:: UnboundDeferredError
Validators
~~~~~~~~~~

View File

@@ -248,7 +248,8 @@ If you use a schema with deferred ``validator``, ``missing`` or
``default`` attributes, but you use it to perform serialization and
deserialization without calling its ``bind`` method:
- If ``validator`` is deferred, no validation will be performed.
- If ``validator`` is deferred, :meth:`~colander.SchemaNode.deserialize` will
raise an :exc:`~colander.UnboundDeferredError`.
- If ``missing`` is deferred, the field will be considered *required*.