Skip to content

Commit 8ede21e

Browse files
chore: default enum description to "An enumeration." (#1502)
* Default enum description to "An enumeration." default to this string, which is used in many tests, is causing * Use the docstring descriptions of enums when they are present * Added tests * chore: add missing newline * Fix new line --------- Co-authored-by: Erik Wrede <erikwrede@users.noreply.github.com>
1 parent 57cbef6 commit 8ede21e

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

graphene/types/enum.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ def from_enum(
6363
cls, enum, name=None, description=None, deprecation_reason=None
6464
): # noqa: N805
6565
name = name or enum.__name__
66-
description = description or enum.__doc__
66+
description = description or enum.__doc__ or "An enumeration."
6767
meta_dict = {
6868
"enum": enum,
6969
"description": description,

graphene/types/tests/test_enum.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,21 @@ def test_enum_from_builtin_enum():
6565
assert RGB.BLUE
6666

6767

68+
def test_enum_custom_description_in_constructor():
69+
description = "An enumeration, but with a custom description"
70+
RGB = Enum(
71+
"RGB",
72+
"RED,GREEN,BLUE",
73+
description=description,
74+
)
75+
assert RGB._meta.description == description
76+
77+
78+
def test_enum_from_python3_enum_uses_default_builtin_doc():
79+
RGB = Enum("RGB", "RED,GREEN,BLUE")
80+
assert RGB._meta.description == "An enumeration."
81+
82+
6883
def test_enum_from_builtin_enum_accepts_lambda_description():
6984
def custom_description(value):
7085
if not value:

0 commit comments

Comments
 (0)