Skip to content

Commit 141dfd1

Browse files
committed
updating doc
1 parent 897bbed commit 141dfd1

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

extras_mongoengine/fields.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,10 @@ def validate(self, value):
6767

6868
class EnumField(object):
6969
"""
70-
A class to register Enum type into mongo
70+
A class to register Enum type (from the package enum34) into mongo
7171
72-
:param choices: must be of enum type and will be used as possible choices
72+
:param choices: must be of :class:`enum.Enum`: type
73+
and will be used as possible choices
7374
"""
7475

7576
def __init__(self, enum, *args, **kwargs):
@@ -99,8 +100,12 @@ def _validate(self, value, **kwargs):
99100

100101

101102
class IntEnumField(EnumField, IntField):
103+
"""A variation on :class:`EnumField` for only int containing enumeration.
104+
"""
102105
pass
103106

104107

105108
class StringEnumField(EnumField, StringField):
109+
"""A variation on :class:`EnumField` for only string containing enumeration.
110+
"""
106111
pass

0 commit comments

Comments
 (0)