diff --git a/CHANGES.txt b/CHANGES.txt index 6f448cb7..09e490e9 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -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) ------------------ diff --git a/docs/basics.rst b/docs/basics.rst index eb7b13da..1c4ddf2d 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -134,8 +134,9 @@ of the *name*. 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. -The *schema_order* of a schema node is an integer which defines its ultimate -order position within its parent node. It is not useful unless a mapping +The *insert_before* of a schema node is a string: if supplied, it names +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 ordering of the resulting nodes.