aboutsummaryrefslogtreecommitdiff
path: root/tests/test_docstring_options.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/test_docstring_options.py')
-rw-r--r--tests/test_docstring_options.py24
1 files changed, 23 insertions, 1 deletions
diff --git a/tests/test_docstring_options.py b/tests/test_docstring_options.py
index 8ee66138..e6f5a9d9 100644
--- a/tests/test_docstring_options.py
+++ b/tests/test_docstring_options.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
from pybind11_tests import docstring_options as m
@@ -40,3 +39,26 @@ def test_docstring_options():
# Suppression of user-defined docstrings for non-function objects
assert not m.DocstringTestFoo.__doc__
assert not m.DocstringTestFoo.value_prop.__doc__
+
+ # Check existig behaviour of enum docstings
+ assert (
+ m.DocstringTestEnum1.__doc__
+ == "Enum docstring\n\nMembers:\n\n Member1\n\n Member2"
+ )
+
+ # options.enable_enum_members_docstring()
+ assert (
+ m.DocstringTestEnum2.__doc__
+ == "Enum docstring\n\nMembers:\n\n Member1\n\n Member2"
+ )
+
+ # options.disable_enum_members_docstring()
+ assert m.DocstringTestEnum3.__doc__ == "Enum docstring"
+
+ # options.disable_user_defined_docstrings()
+ assert m.DocstringTestEnum4.__doc__ == "Members:\n\n Member1\n\n Member2"
+
+ # options.disable_user_defined_docstrings()
+ # options.disable_enum_members_docstring()
+ # When all options are disabled, no docstring (instead of an empty one) should be generated
+ assert m.DocstringTestEnum5.__doc__ is None