Permalink
Browse files

Changed the docs to reflect the new colander.drop object.

  • Loading branch information...
1 parent 21f5259 commit a564f43d06c3b60ba48f0d42ead46fb38512a121 @jayd3e jayd3e committed Mar 19, 2013
Showing with 7 additions and 1 deletion.
  1. +3 −1 colander/__init__.py
  2. +4 −0 docs/api.rst
View
@@ -1652,7 +1652,9 @@ class _SchemaNode(object):
not provided, the missing value of this node will be the special marker
value :attr:`colander.required`, indicating that it is considered
'required'. When ``missing`` is :attr:`colander.required`, the
- ``required`` computed attribute will be ``True``.
+ ``required`` computed attribute will be ``True``. When ``missing`` is
+ :attr:`colander.drop`, the node is dropped from the schema if it isn't
+ set during serialization/deserialization.
- ``preparer``: Optional preparer for this node. It should be
an object that implements the
View
@@ -139,3 +139,7 @@ Schema-Related
.. attribute:: required
Represents a required value in colander-related operations.
+
+ .. attribute:: drop
+ Represents a value that will be dropped from the schema if it is missing. Passed
+ ass a value to the `missing` keyword argument.

0 comments on commit a564f43

Please sign in to comment.