Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(core): Add docstring examples for Runnables #7066

Merged
merged 3 commits into from
Oct 29, 2024

Conversation

SkSirius
Copy link
Contributor

This pull request introduces updates to the API reference examples for a set of Runnable interfaces.
The API Reference page is missing examples for the following Runnables:

  • RouterRunnable
  • RunnableAssign
  • RunnableBinding
  • RunnableEach
  • RunnableLambda
  • RunnableParallel
  • RunnablePick
  • RunnableRetry
  • RunnableWithFallbacks

All examples were tested and are working.
I've created a separate repo to illustrate it: SkSirius/langchain-js-examples

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Oct 25, 2024
Copy link

vercel bot commented Oct 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
langchainjs-docs ✅ Ready (Inspect) Visit Preview Oct 29, 2024 8:28pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
langchainjs-api-refs ⬜️ Ignored (Inspect) Oct 29, 2024 8:28pm

@dosubot dosubot bot added the auto:documentation Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Oct 25, 2024
@jacoblee93
Copy link
Collaborator

Ah thank you for this!

Verified

This commit was signed with the committer’s verified signature.
targos Michaël Zasso
Copy link
Collaborator

@jacoblee93 jacoblee93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is super helpful, thanks again!

@dosubot dosubot bot added the lgtm PRs that are ready to be merged as-is label Oct 29, 2024
@jacoblee93 jacoblee93 changed the title API Reference: Examples for Runnables docs(core): Examples for Runnables for API refs Oct 29, 2024
@jacoblee93 jacoblee93 changed the title docs(core): Examples for Runnables for API refs docs(core): Add docstring examples for Runnables Oct 29, 2024
@jacoblee93 jacoblee93 merged commit c5d1503 into langchain-ai:main Oct 29, 2024
36 checks passed
FilipZmijewski pushed a commit to FilipZmijewski/langchainjs that referenced this pull request Oct 31, 2024

Verified

This commit was signed with the committer’s verified signature.
aduh95 Antoine du Hamel
Co-authored-by: jacoblee93 <jacoblee93@gmail.com>
aditishree1 pushed a commit to aditishree1/langchainjs that referenced this pull request Nov 1, 2024

Verified

This commit was signed with the committer’s verified signature.
aduh95 Antoine du Hamel
Co-authored-by: jacoblee93 <jacoblee93@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto:documentation Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder lgtm PRs that are ready to be merged as-is size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants