openstack/deb-python-colander
Code Issues Proposed changes

Sync documentation for 'insert_before' rather than 'schema_order'.

Browse Source 
Fixes #104
This commit is contained in:
Tres Seaver
2013-05-02 13:19:25 -04:00
parent e83cebbc40
commit f0db476930
2 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
CHANGES.txt
View File

@@ -1,3 +1,13 @@
Unreleased
------------------
Bug Fixes
~~~~~~~~~
- Sync documentation with 0.9.9 change to use ``insert_before`` rather than
``schema_order``. See https://github.com/Pylons/colander/issues/104
1.0a2 (2013-01-30) 1.0a2 (2013-01-30)
------------------ ------------------

5
docs/basics.rst
View File

@@ -134,8 +134,9 @@ 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 *schema_order* of a schema node is an integer which defines its ultimate The *insert_before* of a schema node is a string: if supplied, it names
order position within its parent node. It is not useful unless a mapping a sibling defined by a superclass for its parent node; the current node
will be inserted before the named node. It is not useful unless a mapping
schema is inherited from another mapping schema, and you need to control the schema is inherited from another mapping schema, and you need to control the
ordering of the resulting nodes. ordering of the resulting nodes.