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.

Sign up for GitHub

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

Jump to bottom

Improvement [docs] Improve api docs #27787

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Improvement [docs] Improve api docs #27787

merged 2 commits into from
Oct 31, 2024

Conversation

ZhangShenao
Copy link
Contributor

  • Add missing param
  • Remove unused param

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Oct 31, 2024
@vercel Vercel
Copy link

vercel bot commented Oct 31, 2024 •
edited
Loading

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

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
langchain ⬜️ Ignored (Inspect) Visit Preview Oct 31, 2024 4:51pm

@dosubot dosubot bot added the 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Oct 31, 2024
ccurme
ccurme approved these changes Oct 31, 2024
View reviewed changes
Copy link
Collaborator

@ccurme ccurme left a comment

Choose a reason for hiding this comment

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

Thanks for this. I kept tool_choice in the docstring for ChatMistralAI.bind_tools as it's a valid / important kwarg. May be better to make it explicit but IMO it's helpful in the API ref. Let me know if you disagree.

@dosubot dosubot bot added the lgtm PR looks good. Use to confirm that a PR is ready for merging. label Oct 31, 2024
@ccurme ccurme enabled auto-merge (squash) October 31, 2024 16:52
@ccurme ccurme merged commit ad0387a into langchain-ai:master Oct 31, 2024
78 checks passed
@ZhangShenao
Copy link
Contributor Author

Thanks for this. I kept tool_choice in the docstring for ChatMistralAI.bind_tools as it's a valid / important kwarg. May be better to make it explicit but IMO it's helpful in the API ref. Let me know if you disagree.

No problem, I agree with this.

@ZhangShenao ZhangShenao deleted the improve-core branch November 1, 2024 01:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ccurme ccurme ccurme approved these changes

Assignees
No one assigned
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder lgtm PR looks good. Use to confirm that a PR is ready for merging. size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
PR Reviews
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ZhangShenao @ccurme