Skip to content

Commit

Permalink
Changed aims
Browse files Browse the repository at this point in the history
  • Loading branch information
domdfcoding committed Jul 14, 2020
1 parent a33cf9f commit 81ed36c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 10 deletions.
8 changes: 3 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 16 additions & 5 deletions doc-source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -150,3 +149,15 @@ View the :ref:`Function Index <genindex>` or browse the `Source Code <_modules/i
`Browse the GitHub Repository <https://github.com/domdfcoding/enum_tools>`__

.. end links
Further Reading
-----------------------

#. https://docs.python.org/3/library/enum.html

#. `Is it possible to define a class constant inside an Enum? <https://stackoverflow.com/q/17911188/3092681>`_

#. `Enums with Attributes <https://stackoverflow.com/a/19300424/3092681>`_

#. `When should I subclass EnumMeta instead of Enum? <https://stackoverflow.com/a/43730306/3092681>`_

0 comments on commit 81ed36c

Please sign in to comment.