Skip to content

Commit ba4af8f

Browse files
committed
update readme and changelog
1 parent 30c41a8 commit ba4af8f

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Many packages aim to ease usage of Python enumerations as model fields. Most wer
8787

8888
## Flag Support
8989

90-
[Flag](https://docs.python.org/3/library/enum.html#enum.Flag) types are also seamlessly supported! This allows a database column to behave like a bit mask and is an alternative to multiple boolean columns. There are mostly positive performance implications for using a bit mask instead of booleans depending on the size of the bit mask and the types of queries you will run against it. For bit masks more than a few bits long the size reduction both speeds up queries and reduces the required storage space. See the documentation for [discussion and benchmarks]().
90+
[Flag](https://docs.python.org/3/library/enum.html#enum.Flag) types are also seamlessly supported! This allows a database column to behave like a bit mask and is an alternative to multiple boolean columns. There are mostly positive performance implications for using a bit mask instead of booleans depending on the size of the bit mask and the types of queries you will run against it. For bit masks more than a few bits long the size reduction both speeds up queries and reduces the required storage space. See the documentation for [discussion and benchmarks](https://django-enum.readthedocs.io/en/latest/performance.html#flags).
9191

9292
```python
9393

doc/source/changelog.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,20 @@ v2.0.0 (2024-09-09)
99

1010
* Completed `Reorganize tests <https://github.com/bckohan/django-enum/issues/70>`_
1111
* Completed `Switch linting and formatting to ruff <https://github.com/bckohan/django-enum/issues/62>`_
12+
* Implemented `Install django-stubs when running static type checks. <https://github.com/bckohan/django-enum/issues/60>`_
1213
* Implemented `Supply a mixin for DRF ModelSerializers that instantiates the provided DRF EnumField type for model EnumFields. <https://github.com/bckohan/django-enum/issues/47>`_
1314
* Implemented `EnumField's should inherit from common base titled EnumField <https://github.com/bckohan/django-enum/issues/46>`_
1415
* Implemented `Add database constraints on enum fields by default. <https://github.com/bckohan/django-enum/issues/45>`_
1516
* Fixed `to_python() raises ValueError instead of spec'ed ValidationError <https://github.com/bckohan/django-enum/issues/44>`_
1617
* Implemented `Add support for date, datetime, timedelta, time and Decimal enumeration types. <https://github.com/bckohan/django-enum/issues/43>`_
1718
* Fixed `None should be an allowable enumeration value in enums of any primitive type. <https://github.com/bckohan/django-enum/issues/42>`_
19+
* Implemented `Characterize the performance trade offs of bitfields vs indexed and non-indexed boolean fields. <https://github.com/bckohan/django-enum/issues/41>`_
1820
* Fixed `When coerce is false, to_python does not convert to the Enum's primitive type <https://github.com/bckohan/django-enum/issues/39>`_
1921
* Implemented `Provide parameter to override integer range on EnumField. <https://github.com/bckohan/django-enum/issues/38>`_
2022
* Implemented `Add all official supported Django RDBMS backends to CI <https://github.com/bckohan/django-enum/issues/33>`_
23+
* Implemented `Support for integer sizes greater than 64 bit <https://github.com/bckohan/django-enum/issues/32>`_
2124
* Implemented `Provide an optional enum path converter. <https://github.com/bckohan/django-enum/issues/22>`_
22-
25+
* Implemented `Support flag enumerations <https://github.com/bckohan/django-enum/issues/7>`_
2326

2427
.. _migration_1.x_to_2.x:
2528

0 commit comments

Comments
 (0)