openstack/deb-python-colander
Code Issues Proposed changes

Fix API.

Browse Source
This commit is contained in:
Chris McDonough
2010-03-17 20:55:25 +00:00
parent 9481e7180b
commit 0d22119c9e
2 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api.rst
View File

@@ -45,14 +45,12 @@ Types
.. autoclass:: GlobalObject .. autoclass:: GlobalObject
Other Schema-Related
~~~~~ ~~~~~~~~~~~~~~
.. autoclass:: Structure(typ,*structs,name='',default=MISSING,validator=None) .. autoclass:: SchemaNode(typ,*nodes,name='',default=MISSING,validator=None)
:members: :members:
.. autoclass:: Struct
.. autoclass:: Schema .. autoclass:: Schema
.. autoclass:: MappingSchema .. autoclass:: MappingSchema

4
docs/index.rst
View File

@@ -118,8 +118,8 @@ of our definitions, a ``Person`` represents:
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
A schema is composed of one or more *schema node* objects, each A schema is composed of one or more *schema node* objects, each
typically of the class ``colander.SchemaNode``, usually in a nested typically of the class :class:`colander.SchemaNode`, usually in a
arrangement. Each schema node object has a required *type*, an nested arrangement. Each schema node object has a required *type*, an
optional deserialization *validator*, an optional *default*, and a optional deserialization *validator*, an optional *default*, and a
slightly less optional *name*. slightly less optional *name*.