Skip to content

Commit bc7cf59

Browse files
committed
build: Depend on Griffe 1.14
1 parent 4d3ff0c commit bc7cf59

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ classifiers = [
3131
"Typing :: Typed",
3232
]
3333
dependencies = [
34-
"griffe>=0.49",
34+
"griffe>=1.14",
3535
"typing-extensions>=4.7",
3636
]
3737

src/griffe_typingdoc/_internal/docstrings.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Helpers to build docstring sections."""
1+
# Helpers to build docstring sections.
22

33
from __future__ import annotations
44

@@ -40,7 +40,7 @@ def _to_parameters_section(params_dict: dict[str, dict[str, Any]], func: Functio
4040
name=param_name,
4141
description=param_doc["description"],
4242
annotation=param_doc["annotation"],
43-
value=func.parameters[param_name].default, # type: ignore[arg-type]
43+
value=func.parameters[param_name].default,
4444
)
4545
for param_name, param_doc in params_dict.items()
4646
],

src/griffe_typingdoc/_internal/dynamic.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Helpers to get documentation metadata dynamically."""
1+
# Helpers to get documentation metadata dynamically.
22

33
from __future__ import annotations
44

src/griffe_typingdoc/_internal/extension.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
"""This module defines the Griffe TypingDoc extension."""
1+
# This module defines the Griffe TypingDoc extension.
22

33
from __future__ import annotations
44

55
from typing import TYPE_CHECKING, Any
66

7-
from griffe import Docstring, Extension, Function, ObjectNode
7+
from griffe import Alias, Docstring, Extension, Function, ObjectNode
88

99
from griffe_typingdoc._internal import dynamic, static
1010

@@ -103,18 +103,18 @@ def _handle_function(self, func: Function, /, *, node: ObjectNode | None = None)
103103
if returns_section:
104104
sections.append(returns_section)
105105

106-
def _handle_object(self, obj: Object) -> None:
106+
def _handle_object(self, obj: Object | Alias) -> None:
107107
if obj.is_alias:
108108
return
109109
if obj.is_module or obj.is_class:
110110
for member in obj.members.values():
111111
self._handle_object(member)
112112
elif obj.is_function:
113-
self._handle_function(obj)
113+
self._handle_function(obj) # type: ignore[arg-type]
114114
elif obj.is_attribute:
115-
self._handle_attribute(obj)
115+
self._handle_attribute(obj) # type: ignore[arg-type]
116116

117-
def on_package_loaded(
117+
def on_package(
118118
self,
119119
*,
120120
pkg: Annotated[

src/griffe_typingdoc/_internal/static.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Helpers to get documentation metadata statically."""
1+
# Helpers to get documentation metadata statically.
22

33
from __future__ import annotations
44

@@ -24,16 +24,16 @@
2424
if TYPE_CHECKING:
2525
from collections.abc import Sequence
2626

27-
from griffe import Function
28-
from griffe.dataclasses import Attribute
29-
from griffe.docstrings.dataclasses import (
27+
from griffe import (
28+
Attribute,
3029
DocstringSectionAdmonition,
3130
DocstringSectionParameters,
3231
DocstringSectionRaises,
3332
DocstringSectionReceives,
3433
DocstringSectionReturns,
3534
DocstringSectionWarns,
3635
DocstringSectionYields,
36+
Function,
3737
)
3838

3939

0 commit comments

Comments
 (0)