docs: Add typehints in both signature and description of API docs #17815
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dosubot
bot
added
the
size:XS
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dosubot
bot
added
the
🤖:docs
k8si
pushed a commit
to Mozilla-Ocho/langchain
that referenced
this pull request
Feb 22, 2024
…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_
al1p
pushed a commit
to al1p/langchain
that referenced
this pull request
Feb 27, 2024
…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_
haydeniw
pushed a commit
to haydeniw/langchain
that referenced
this pull request
Feb 27, 2024
…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_
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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_