Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

tests: get_object returns annotations from pyi stub files #360

Merged
merged 1 commit into from
Aug 22, 2024
Merged

tests: get_object returns annotations from pyi stub files #360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions quartodoc/tests/example_stubs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
def f(a, b):
"""The original docstring."""
2 changes: 2 additions & 0 deletions quartodoc/tests/example_stubs.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
def f(a: int, b: str):
"""The stub docstring"""
5 changes: 5 additions & 0 deletions quartodoc/tests/test_basic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading