Skip to content

Commit 504bd18

Browse files
committed
add Jacob and old code base link to changelog
1 parent ad03c8a commit 504bd18

File tree

4 files changed

+13
-11
lines changed

4 files changed

+13
-11
lines changed

README.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ Django Enum
3636

3737
Full and natural support for enumerations_ as Django model fields.
3838

39-
`django-enum <https://django-enum.readthedocs.io/en/latest/>`_ provides a new
39+
`django-enum <https://django-enum.readthedocs.io/en/latest/>`_ works in concert
40+
with Django_'s built in ``TextChoices`` and ``IntegerChoices`` to provide a new
4041
model field type, ``EnumField``, that resolves the correct native Django_ field
4142
type for the given enumeration based on its value type and range. For example,
4243
``IntegerChoices`` that contain values between 0 and 32767 become
@@ -70,8 +71,8 @@ type for the given enumeration based on its value type and range. For example,
7071
int_enum = EnumField(IntEnum)
7172
7273
73-
``EnumField`` *is more than just an alias. The fields are now assignable and
74-
accessible as their enumeration type rather than by-value:*
74+
``EnumField`` **is more than just an alias. The fields are now assignable and
75+
accessible as their enumeration type rather than by-value:**
7576

7677
.. code:: python
7778

django_enum/fields.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -328,8 +328,8 @@ def EnumField( # pylint: disable=C0103
328328
**field_kwargs
329329
) -> Field:
330330
"""
331-
Some syntactic sugar that wraps the enum field metaclass so that we can
332-
cleanly create enums like so:
331+
*This is a function, not a type*. Some syntactic sugar that wraps the enum
332+
field metaclass so that we can cleanly create enums like so:
333333
334334
.. code-block::
335335
@@ -344,9 +344,9 @@ class EnumType(IntegerChoices):
344344
field_name = EnumField(EnumType)
345345
346346
:param enum: The class of the enumeration.
347-
:param field_args: Any standard unnamed field arguments for the underlying
347+
:param field_args: Any standard unnamed field arguments for the base
348348
field type.
349-
:param field_kwargs: Any standard named field arguments for the underlying
349+
:param field_kwargs: Any standard named field arguments for the base
350350
field type.
351351
:return: An object of the appropriate enum field type
352352
"""

doc/source/changelog.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ v1.0.0
1111
v0.1.0
1212
======
1313

14-
* Legacy django-enum library, old code base located here.
14+
* Legacy django-enum library maintained by `Jacob Smulloni <https://pypi.org/user/smulloni>`_. Source located `here <https://github.com/smulloni/django-enum-old>`_.

doc/source/index.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Django Enum
66

77
Full and natural support for enumerations_ as Django model fields.
88

9-
`django-enum <https://django-enum.readthedocs.io/en/latest/>`_ provides a new
9+
`django-enum <https://django-enum.readthedocs.io/en/latest/>`_ works in concert
10+
with Django_'s built in ``TextChoices`` and ``IntegerChoices`` to provide a new
1011
model field type, ``EnumField``, that resolves the correct native Django_ field
1112
type for the given enumeration based on its value type and range. For example,
1213
``IntegerChoices`` that contain values between 0 and 32767 become
@@ -40,8 +41,8 @@ type for the given enumeration based on its value type and range. For example,
4041
int_enum = EnumField(IntEnum)
4142
4243
43-
``EnumField`` *is more than just an alias. The fields are now assignable and
44-
accessible as their enumeration type rather than by-value:*
44+
``EnumField`` **is more than just an alias. The fields are now assignable and
45+
accessible as their enumeration type rather than by-value:**
4546

4647
.. code:: python
4748

0 commit comments

Comments
 (0)