Merge pull request #88 from bazzilic/BooleanFields

Boolean fields
heynemann · Mar 16, 2015 · 7ec9114 · 7ec9114
2 parents ed1c9b7 + ffc89fb
commit 7ec9114
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/source/modeling.rst b/docs/source/modeling.rst
@@ -12,6 +12,7 @@ Modeling
 .. py:module:: motorengine.fields.url_field
 .. py:module:: motorengine.fields.email_field
 .. py:module:: motorengine.fields.int_field
+.. py:module:: motorengine.fields.boolean_field
 .. py:module:: motorengine.fields.float_field
 .. py:module:: motorengine.fields.decimal_field
 .. py:module:: motorengine.fields.binary_field
@@ -123,6 +124,8 @@ Available Fields
 
 .. autoclass:: motorengine.fields.int_field.IntField
 
+.. autoclass:: motorengine.fields.int_field.BooleanField
+
 .. autoclass:: motorengine.fields.float_field.FloatField
 
 .. autoclass:: motorengine.fields.decimal_field.DecimalField

diff --git a/motorengine/fields/boolean_field.py b/motorengine/fields/boolean_field.py
@@ -5,6 +5,13 @@
 
 
 class BooleanField(BaseField):
+    '''
+    Field responsible for storing boolean values (:py:func:`bool`).
+    Usage:
+    .. testcode:: modeling_fields
+        isActive = BooleanField(required=True)
+    `BooleanField` has no additional arguments available (apart from those in `BaseField`).
+    '''
     def __init__(self, *args, **kw):
         super(BooleanField, self).__init__(*args, **kw)