diff --git a/quartodoc/tests/example_stubs.py b/quartodoc/tests/example_stubs.py new file mode 100644 index 0000000..bfedc74 --- /dev/null +++ b/quartodoc/tests/example_stubs.py @@ -0,0 +1,2 @@ +def f(a, b): + """The original docstring.""" diff --git a/quartodoc/tests/example_stubs.pyi b/quartodoc/tests/example_stubs.pyi new file mode 100644 index 0000000..a9ef3ce --- /dev/null +++ b/quartodoc/tests/example_stubs.pyi @@ -0,0 +1,2 @@ +def f(a: int, b: str): + """The stub docstring""" diff --git a/quartodoc/tests/test_basic.py b/quartodoc/tests/test_basic.py index 9cad892..b46b8f8 100644 --- a/quartodoc/tests/test_basic.py +++ b/quartodoc/tests/test_basic.py @@ -56,6 +56,11 @@ def test_render_attribute(): assert MdRenderer().render(a) == "I am an attribute docstring" +def test_get_object_stub_pyi(): + obj = get_object("quartodoc.tests.example_stubs:f") + assert obj.parameters[0].annotation.name == "int" + + def test_get_object_dynamic_module_root(): obj = get_object("quartodoc", dynamic=True) assert isinstance(obj, dc.Module)