openstack/deb-python-colander
Code Issues Proposed changes

Merge pull request #232 from tisdall/update_docs_typ

Browse Source 
Update docs regarding `typ` argument to SchemaNode
This commit is contained in:
Michael Merickel
2015-07-02 10:05:50 -05:00
parent ccc31c1ead 4851bbb141
commit b1b95374dc
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
colander/__init__.py
View File

@@ -1787,7 +1787,9 @@ class _SchemaNode(object):
- ``typ``: The 'type' for this node. It should be an
instance of a class that implements the
:class:`colander.interfaces.Type` interface. If ``typ`` is not passed,
it defaults to ``colander.Mapping()``.
a call to the ``schema_type()`` method on this class is made to
get a default type. (When subclassing, ``schema_type()`` should
be overridden to provide a reasonable default type).
- ``*children``: a sequence of subnodes. If the subnodes of this
node are not known at construction time, they can later be added