openstack/deb-python-colander
Code Issues Proposed changes

Fix syntax errors in documentation.

Browse Source
This commit is contained in:
Nikola Kotur
2014-01-06 17:14:39 +01:00
parent db27d901ab
commit f7e4a3fe7d
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/basics.rst
View File

@@ -999,7 +999,7 @@ schema, then the schema definition can be made more succinct using the
@colander.instantiate() @colander.instantiate()
class friend(colander.TupleSchema): class friend(colander.TupleSchema):
rank = colander.SchemaNode(colander.Int(), rank = colander.SchemaNode(colander.Int(),
validator=colander.Range(0, 9999)) validator=colander.Range(0, 9999))
name = colander.SchemaNode(colander.String()) name = colander.SchemaNode(colander.String())
@@ -1008,7 +1008,7 @@ schema, then the schema definition can be made more succinct using the
@colander.instantiate() @colander.instantiate()
class phone(colander.MappingSchema): class phone(colander.MappingSchema):
location = colander.SchemaNode(colander.String(), location = colander.SchemaNode(colander.String(),
validator=colander.OneOf(['home', 'work'])) validator=colander.OneOf(['home', 'work']))
number = colander.SchemaNode(colander.String()) number = colander.SchemaNode(colander.String())
@@ -1076,22 +1076,22 @@ We can imperatively construct a completely equivalent schema like so:
import colander import colander
friend = colander.SchemaNode(Tuple()) friend = colander.SchemaNode(colander.Tuple())
friend.add(colander.SchemaNode(colander.Int(), friend.add(colander.SchemaNode(colander.Int(),
validator=colander.Range(0, 9999), validator=colander.Range(0, 9999),
name='rank')) name='rank'))
friend.add(colander.SchemaNode(colander.String(), name='name') friend.add(colander.SchemaNode(colander.String(), name='name'))
phone = colander.SchemaNode(Mapping()) phone = colander.SchemaNode(colander.Mapping())
phone.add(colander.SchemaNode(colander.String(), phone.add(colander.SchemaNode(colander.String(),
validator=colander.OneOf(['home', 'work']), validator=colander.OneOf(['home', 'work']),
name='location')) name='location'))
phone.add(colander.SchemaNode(colander.String(), name='number')) phone.add(colander.SchemaNode(colander.String(), name='number'))
schema = colander.SchemaNode(Mapping()) schema = colander.SchemaNode(colander.Mapping())
schema.add(colander.SchemaNode(colander.String(), name='name')) schema.add(colander.SchemaNode(colander.String(), name='name'))
schema.add(colander.SchemaNode(colander.Int(), name='age'), schema.add(colander.SchemaNode(colander.Int(), name='age',
validator=colander.Range(0, 200)) validator=colander.Range(0, 200)))
schema.add(colander.SchemaNode(colander.Sequence(), friend, name='friends')) schema.add(colander.SchemaNode(colander.Sequence(), friend, name='friends'))
schema.add(colander.SchemaNode(colander.Sequence(), phone, name='phones')) schema.add(colander.SchemaNode(colander.Sequence(), phone, name='phones'))
@@ -1129,7 +1129,7 @@ For example, in a Python module, you might have code that looks like this:
.. code-block:: python .. code-block:: python
from colander import MappingSchema from colander import SchemaNode, MappingSchema
from colander import Int from colander import Int
class MySchema1(MappingSchema): class MySchema1(MappingSchema):