Skip to content

docs: standardize OllamaLLM and BaseOpenAI docstrings #32758

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
Merged
merged 5 commits into from
Aug 31, 2025
Merged

docs: standardize OllamaLLM and BaseOpenAI docstrings #32758

merged 5 commits into from
Aug 31, 2025

Conversation

raviraj-441
Copy link
Contributor

@raviraj-441 raviraj-441 commented Aug 30, 2025 •
edited by mdrxy
Loading

  • Add comprehensive docstring following LangChain standards
  • Include Setup, Key init args, Instantiate, Invoke, Stream, and Async sections
  • Provide detailed parameter descriptions and code examples
  • Fix linting issues for code formatting compliance

Contributes to #24803

@vercel Vercel
Copy link

vercel bot commented Aug 30, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
langchain Ignored Ignored Preview Aug 31, 2025 8:25pm

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Aug 30, 2025 •
edited
Loading

CodSpeed WallTime Performance Report

Merging #32758 will not alter performance

Comparing raviraj-441:docs/llm-docstring-standardization (cb0b177) with master (e0a4af8)

⚠️ Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

Summary

✅ 13 untouched benchmarks

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Aug 30, 2025 •
edited
Loading

CodSpeed Instrumentation Performance Report

Merging #32758 will not alter performance

Comparing raviraj-441:docs/llm-docstring-standardization (cb0b177) with master (e0a4af8)

Summary

✅ 14 untouched benchmarks

@raviraj-441
docs(ollama): standardize OllamaLLM docstring format
688a2c1 
- Add comprehensive docstring following LangChain standards
- Include Setup, Key init args, Instantiate, Invoke, Stream, and Async sections
- Provide detailed parameter descriptions and code examples
- Fix linting issues for code formatting compliance

Contributes to langchain-ai#24803
@raviraj-441 raviraj-441 force-pushed the docs/llm-docstring-standardization branch from c982a4d to 688a2c1 Compare August 30, 2025 17:18
mdrxy
mdrxy reviewed Aug 30, 2025
View reviewed changes
mdrxy
mdrxy reviewed Aug 30, 2025
View reviewed changes
@mdrxy mdrxy changed the title docs(ollama): standardize OllamaLLM docstring format docs: standardize OllamaLLM and BaseOpenAI docstrings Aug 30, 2025
@mdrxy mdrxy added documentation Improvements or additions to documentation integration Related to a provider partner package integration labels Aug 30, 2025
@mdrxy mdrxy self-assigned this Aug 30, 2025
mdrxy
mdrxy reviewed Aug 31, 2025
View reviewed changes
@raviraj-441 @mdrxy
Update libs/partners/ollama/langchain_ollama/llms.py
cb0b177 
Co-authored-by: Mason Daugherty <github@mdrxy.com>
@mdrxy mdrxy merged commit b42dac5 into langchain-ai:master Aug 31, 2025
79 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mdrxy mdrxy mdrxy left review comments

Assignees

@mdrxy mdrxy

Labels
documentation Improvements or additions to documentation integration Related to a provider partner package integration
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@raviraj-441 @mdrxy