Skip to content

Commit 33555e5

Browse files
authored
docs: Add typehints in both signature and description of API docs (langchain-ai#17815)
This way we can document APIs in methods signature only where they are checked by the typing system and we get them also in the param description without having to duplicate in the docstrings (where they are unchecked). Twitter: @cbornet_
1 parent 92e52e8 commit 33555e5

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/api_reference/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,8 @@ def setup(app):
114114
autodoc_member_order = "groupwise"
115115
autoclass_content = "both"
116116
autodoc_typehints_format = "short"
117+
autodoc_typehints = "both"
117118

118-
# autodoc_typehints = "description"
119119
# Add any paths that contain templates here, relative to this directory.
120120
templates_path = ["templates"]
121121

0 commit comments

Comments
 (0)