openstack/deb-python-colander
Code Issues Proposed changes

mention widget

Browse Source
This commit is contained in:
Chris McDonough
2010-08-30 02:50:54 +00:00
parent 18c21babed
commit 2453bbf901
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/basics.rst
View File

@@ -91,8 +91,8 @@ A schema is composed of one or more *schema node* objects, each
typically of the class :class:`colander.SchemaNode`, usually in a typically of the class :class:`colander.SchemaNode`, usually in a
nested 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*, an optional deserialization *validator*, an optional *default*, an
optional *missing*, an optional *title*, an optional *description*, optional *missing*, an optional *title*, an optional *description*, an
and a slightly less optional *name*. optional *widget*, and a slightly less optional *name*.
The *type* of a schema node indicates its data type (such as The *type* of a schema node indicates its data type (such as
:class:`colander.Int` or :class:`colander.String`). :class:`colander.Int` or :class:`colander.String`).
@@ -124,6 +124,12 @@ of the *name*.
The *description* of a schema node is metadata about a schema node The *description* of a schema node is metadata about a schema node
that can be used by higher-level systems. By default, it is empty. that can be used by higher-level systems. By default, it is empty.
The *widget* of a schema node is a concept used only by higher level
systems (such as form systems). By default it is ``None``. It won't
be discussed any further in the Colander documentation; it will
instead be explained in the context of the documentation of systems
which make use of it.
The name of a schema node that is introduced as a class-level The name of a schema node that is introduced as a class-level
attribute of a :class:`colander.MappingSchema`, attribute of a :class:`colander.MappingSchema`,
:class:`colander.TupleSchema` or a :class:`colander.SequenceSchema` is :class:`colander.TupleSchema` or a :class:`colander.SequenceSchema` is