Skip to content

chore(langchain): enable ruff docstring-code-format in langchain#32858

Merged
Mason Daugherty (mdrxy) merged 1 commit intolangchain-ai:masterfrom
cbornet:langchain-docstring-code-format
Sep 9, 2025
Merged

chore(langchain): enable ruff docstring-code-format in langchain#32858
Mason Daugherty (mdrxy) merged 1 commit intolangchain-ai:masterfrom
cbornet:langchain-docstring-code-format

Conversation

@cbornet
Copy link
Copy Markdown
Collaborator

No description provided.

@vercel
Copy link
Copy Markdown

vercel bot commented Sep 9, 2025

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 Sep 9, 2025 1:06am

@cbornet Christophe Bornet (cbornet) force-pushed the langchain-docstring-code-format branch 2 times, most recently from c44a93a to 6f8e573 Compare September 9, 2025 00:17
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Sep 9, 2025

CodSpeed WallTime Performance Report

Merging #32858 will not alter performance

Comparing cbornet:langchain-docstring-code-format (34a12c2) with master (714f74a)

⚠️ 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
Copy link
Copy Markdown

codspeed-hq bot commented Sep 9, 2025

CodSpeed Instrumentation Performance Report

Merging #32858 will not alter performance

Comparing cbornet:langchain-docstring-code-format (34a12c2) with master (714f74a)

Summary

✅ 14 untouched benchmarks

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enables ruff's docstring-code-format feature in the langchain library by adding the configuration to pyproject.toml and reformatting code blocks in docstrings throughout the codebase to meet the formatting standards.

Key Changes

  • Enable ruff docstring code formatting in pyproject.toml
  • Format code blocks within docstrings for better readability and consistency
  • Break up long string literals that exceeded line length limits

Reviewed Changes

Copilot reviewed 61 out of 63 changed files in this pull request and generated no comments.

File Description
pyproject.toml Added ruff docstring-code-format configuration
Various test files Reformatted long string literals and multiline code blocks
Various source files Reformatted docstring code examples and broke up long string concatenations

@mdrxy Mason Daugherty (mdrxy) added linting langchain `langchain` package issues & PRs labels Sep 9, 2025
Copy link
Copy Markdown
Member

@mdrxy Mason Daugherty (mdrxy) left a comment

Choose a reason for hiding this comment

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

🔥

@mdrxy Mason Daugherty (mdrxy) merged commit a35ee49 into langchain-ai:master Sep 9, 2025
41 checks passed
@cbornet Christophe Bornet (cbornet) deleted the langchain-docstring-code-format branch December 26, 2025 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

langchain `langchain` package issues & PRs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants