From 0d22119c9e8a4967fd3f0a87d6b57b467354c9af Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 17 Mar 2010 20:55:25 +0000 Subject: [PATCH] Fix API. --- docs/api.rst | 8 +++----- docs/index.rst | 4 ++-- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 096ccc5..02ec6d5 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -45,14 +45,12 @@ Types .. autoclass:: GlobalObject -Other -~~~~~ +Schema-Related +~~~~~~~~~~~~~~ - .. autoclass:: Structure(typ,*structs,name='',default=MISSING,validator=None) + .. autoclass:: SchemaNode(typ,*nodes,name='',default=MISSING,validator=None) :members: - .. autoclass:: Struct - .. autoclass:: Schema .. autoclass:: MappingSchema diff --git a/docs/index.rst b/docs/index.rst index a6dfe09..6fe0f47 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -118,8 +118,8 @@ of our definitions, a ``Person`` represents: ~~~~~~~~~~~~~~~~~~~~~~ A schema is composed of one or more *schema node* objects, each -typically of the class ``colander.SchemaNode``, usually in a nested -arrangement. Each schema node object has a required *type*, an +typically of the class :class:`colander.SchemaNode`, usually in a +nested arrangement. Each schema node object has a required *type*, an optional deserialization *validator*, an optional *default*, and a slightly less optional *name*.