summaryrefslogtreecommitdiff
path: root/ext/pybind11/tests/test_docstring_options.py
diff options
context:
space:
mode:
Diffstat (limited to 'ext/pybind11/tests/test_docstring_options.py')
-rw-r--r--ext/pybind11/tests/test_docstring_options.py12
1 files changed, 11 insertions, 1 deletions
diff --git a/ext/pybind11/tests/test_docstring_options.py b/ext/pybind11/tests/test_docstring_options.py
index 66ad6b89f..5e40f6868 100644
--- a/ext/pybind11/tests/test_docstring_options.py
+++ b/ext/pybind11/tests/test_docstring_options.py
@@ -3,13 +3,23 @@
def test_docstring_options():
from pybind11_tests import (test_function1, test_function2, test_function3,
test_function4, test_function5, test_function6,
- test_function7, DocstringTestFoo)
+ test_function7, DocstringTestFoo,
+ test_overloaded1, test_overloaded2, test_overloaded3)
# options.disable_function_signatures()
assert not test_function1.__doc__
assert test_function2.__doc__ == "A custom docstring"
+ # docstring specified on just the first overload definition:
+ assert test_overloaded1.__doc__ == "Overload docstring"
+
+ # docstring on both overloads:
+ assert test_overloaded2.__doc__ == "overload docstring 1\noverload docstring 2"
+
+ # docstring on only second overload:
+ assert test_overloaded3.__doc__ == "Overload docstr"
+
# options.enable_function_signatures()
assert test_function3.__doc__ .startswith("test_function3(a: int, b: int) -> None")