From 81ed36c9db39b195b73773d43bfdcf46cf970f30 Mon Sep 17 00:00:00 2001 From: Dominic Davis-Foster Date: Tue, 14 Jul 2020 09:58:17 +0100 Subject: [PATCH] Changed aims --- README.rst | 8 +++----- doc-source/index.rst | 21 ++++++++++++++++----- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 5208f86..385deb4 100644 --- a/README.rst +++ b/README.rst @@ -100,13 +100,11 @@ enum_tools | -This package has three aims: +This package has two features: -#. Import from the stdlib ``enum`` module when running mypy, and from ``aenum`` when the code actually runs. This helps mypy understand type annotations, but keeps all of the ``if TYPE_CHECKING:`` code in one place. +#. A decorator to add docstrings to ``Enum`` members from a comment at the end of the line. -#. Provide a decorator to add docstrings to ``Enum`` members from a comment at the end of the line. - -#. Provide a ``Sphinx`` extension to document ``Enum``s better that ``autoclass`` can currently. +#. A ``Sphinx`` extension to document ``Enum``s better than ``autoclass`` can currently. Installation diff --git a/doc-source/index.rst b/doc-source/index.rst index 1d40702..dcb3e41 100644 --- a/doc-source/index.rst +++ b/doc-source/index.rst @@ -97,14 +97,13 @@ enum_tools .. end shields +| -This package has three aims: +This package has two features: -#. Import from the stdlib ``enum`` module when running mypy, and from ``aenum`` when the code actually runs. This helps mypy understand type annotations, but keeps all of the ``if TYPE_CHECKING:`` code in one place. +#. A decorator to add docstrings to ``Enum`` members from a comment at the end of the line. -#. Provide a decorator to add docstrings to ``Enum`` members from a comment at the end of the line. - -#. Provide a ``Sphinx`` extension to document ``Enum``s better that ``autoclass`` can currently. +#. A ``Sphinx`` extension to document ``Enum``s better than ``autoclass`` can currently. Installation @@ -150,3 +149,15 @@ View the :ref:`Function Index ` or browse the `Source Code <_modules/i `Browse the GitHub Repository `__ .. end links + + +Further Reading +----------------------- + +#. https://docs.python.org/3/library/enum.html + +#. `Is it possible to define a class constant inside an Enum? `_ + +#. `Enums with Attributes `_ + +#. `When should I subclass EnumMeta instead of Enum? `_