Skip to content

Commit

Permalink
docs: Add typehints in both signature and description of API docs (la…
Browse files Browse the repository at this point in the history
…ngchain-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_
  • Loading branch information
cbornet authored and k8si committed Feb 22, 2024
1 parent fdd6428 commit b1365c8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/api_reference/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ def setup(app):
autodoc_member_order = "groupwise"
autoclass_content = "both"
autodoc_typehints_format = "short"
autodoc_typehints = "both"

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

Expand Down

0 comments on commit b1365c8

Please sign in to comment.