From 7f59a8fa7e9199ad6cb83e52e85a84944bba7902 Mon Sep 17 00:00:00 2001 From: Eran Kampf Date: Mon, 30 Oct 2017 13:03:01 -0700 Subject: [PATCH] Added docs --- docs/types/enums.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/types/enums.rst b/docs/types/enums.rst index 96c52e92..6e730628 100644 --- a/docs/types/enums.rst +++ b/docs/types/enums.rst @@ -54,6 +54,13 @@ the ``Enum.from_enum`` function. graphene.Enum.from_enum(AlreadyExistingPyEnum) +``Enum.from_enum`` supports a ``description`` and ``deprecation_reason`` lambdas as input so +you can add description etc. to your enum without changing the original: + +.. code:: python + + graphene.Enum.from_enum(AlreadyExistingPyEnum, description=lambda value: return 'foo' if value == AlreadyExistingPyEnum.Foo else 'bar') + Notes ----- @@ -65,7 +72,7 @@ member getters. In the Python ``Enum`` implementation you can access a member by initing the Enum. .. code:: python - + from enum import Enum class Color(Enum): RED = 1 @@ -78,7 +85,7 @@ In the Python ``Enum`` implementation you can access a member by initing the Enu However, in Graphene ``Enum`` you need to call get to have the same effect: .. code:: python - + from graphene import Enum class Color(Enum): RED = 1