summaryrefslogtreecommitdiff
path: root/sphinx/util
diff options
context:
space:
mode:
Diffstat (limited to 'sphinx/util')
-rw-r--r--sphinx/util/typing.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py
index b7c389147..28e492646 100644
--- a/sphinx/util/typing.py
+++ b/sphinx/util/typing.py
@@ -73,7 +73,8 @@ Inventory = Dict[str, Dict[str, InventoryItem]]
def get_type_hints(
obj: Any, globalns: Optional[Dict[str, Any]] = None, localns: Optional[Dict] = None
) -> Dict[str, Any]:
- """Return a dictionary containing type hints for a function, method, module or class object.
+ """Return a dictionary containing type hints for a function, method, module or class
+ object.
This is a simple wrapper of `typing.get_type_hints()` that does not raise an error on
runtime.