Skip to content

Commit 39675dc

Browse files
committed
doc fixes
1 parent 14749cb commit 39675dc

File tree

2 files changed

+27
-24
lines changed

2 files changed

+27
-24
lines changed

README.rst

+15-13
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
.. _enumerations: https://docs.python.org/3/library/enum.html#enum.Enum
3131
.. _ValueError: https://docs.python.org/3/library/exceptions.html#ValueError
3232
.. _DRY: https://en.wikipedia.org/wiki/Don%27t_repeat_yourself
33-
.. _DRF: https://www.django-rest-framework.org
3433

3534
Django Enum
3635
###########
@@ -175,22 +174,25 @@ Installation
175174
176175
pip install django-enum
177176
178-
.. note::
179-
180-
``django-enum`` *does not* need to be added to ``INSTALLED_APPS``.
181-
182177
.. note::
183178

184179
``django-enum`` has several optional dependencies that are not pulled in
185180
by default. ``EnumFields`` work seamlessly with all Django apps that
186-
work with model fields with choices. Optional integrations are provided
187-
with several popular libraries to extend this basic functionality. To
188-
utilize the `enum-properties <https://pypi.org/project/enum-properties/>`_
189-
choice types you must `pip install enum-properties` and to use the
190-
``EnumFilter`` type for
191-
`django-filter <https://pypi.org/project/django-filter/>`_ you
192-
must `pip install django-filter`. And to use the DRF_ serializer field you
193-
must `pip install djangorestframework`.
181+
work with model fields with choices without any additional work. Optional
182+
integrations are provided with several popular libraries to extend this
183+
basic functionality.
184+
185+
Integrations are provided that leverage
186+
`enum-properties <https://pypi.org/project/enum-properties/>`_ to make
187+
enumerations do more work and to provide extended functionality for
188+
`django-filter <https://pypi.org/project/django-filter/>`_ and
189+
`djangorestframework <https://www.django-rest-framework.org>`_.
190+
191+
.. code:: bash
192+
193+
pip install enum-properties
194+
pip install django-filter
195+
pip install djangorestframework
194196
195197
If features are utilized that require a missing optional dependency an
196198
exception will be thrown.

doc/source/index.rst

+12-11
Original file line numberDiff line numberDiff line change
@@ -127,22 +127,23 @@ Installation
127127
128128
pip install django-enum
129129
130-
.. note::
131-
132-
``django-enum`` *does not* need to be added to ``INSTALLED_APPS``.
133130
134131
.. note::
135132

136133
``django-enum`` has several optional dependencies that are not pulled in
137134
by default. ``EnumFields`` work seamlessly with all Django apps that
138-
work with model fields with choices. Optional integrations are provided
139-
with several popular libraries to extend this basic functionality. To
140-
utilize the `enum-properties <https://pypi.org/project/enum-properties/>`_
141-
choice types you must `pip install enum-properties` and to use the
142-
``EnumFilter`` type for
143-
`django-filter <https://pypi.org/project/django-filter/>`_ you
144-
must `pip install django-filter`. And to use the DRF_ serializer field you
145-
must `pip install djangorestframework`.
135+
work with model fields with choices without any additional work. Optional
136+
integrations are provided with several popular libraries to extend this
137+
basic functionality.
138+
139+
Integrations are provided that leverage enum-properties_ to make enumerations
140+
do more work and to provide extended functionality for django-filter_ and DRF_.
141+
142+
.. code:: bash
143+
144+
pip install enum-properties
145+
pip install django-filter
146+
pip install djangorestframework
146147
147148
If features are utilized that require a missing optional dependency an
148149
exception will be thrown.

0 commit comments

Comments
 (0)