Skip to content

Commit f3c6f4e

Browse files
committed
feat: Support annotated_doc package
1 parent fc76c0b commit f3c6f4e

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

src/griffe_typingdoc/_internal/static.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ def _set_metadata_warns(metadata: dict[str, Any], data: ExprCall) -> None:
6262

6363

6464
_set_metadata_map = {
65+
"annotated_doc.Doc": _set_metadata_doc,
6566
"typing.Doc": _set_metadata_doc,
6667
"typing_extensions.Doc": _set_metadata_doc,
6768
"typing.deprecated": _set_metadata_deprecated,

tests/test_extension.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,3 +298,23 @@ def test_ignore_unannotated_receives(annotation: str) -> None:
298298
sections = package["f"].docstring.parsed
299299
assert len(sections) == 1
300300
assert sections[0].kind is DocstringSectionKind.text
301+
302+
303+
def test_support_annotated_doc_package() -> None:
304+
"""Test that the extension supports annotated-doc's Doc."""
305+
code = """
306+
from typing import Annotated
307+
from annotated_doc import Doc
308+
def hi(name: Annotated[str, Doc('Who to say hi to')]) -> None:
309+
'''Says hi.'''
310+
pass
311+
"""
312+
with temporary_visited_package(
313+
"package",
314+
modules={"__init__.py": code},
315+
extensions=Extensions(TypingDocExtension()),
316+
) as package:
317+
sections = package["hi"].docstring.parsed
318+
assert len(sections) == 2
319+
assert sections[1].kind is DocstringSectionKind.parameters
320+
assert sections[1].value[0].description == "Who to say hi to"

0 commit comments

Comments
 (0)