Skip to content

fix(core): correct parameter names in filter_messages docstring example#36462

Merged
ccurme (ccurme) merged 1 commit intolangchain-ai:masterfrom
ujjwalredd:fix/filter-messages-docstring-param-names
Apr 3, 2026
Merged

fix(core): correct parameter names in filter_messages docstring example#36462
ccurme (ccurme) merged 1 commit intolangchain-ai:masterfrom
ujjwalredd:fix/filter-messages-docstring-param-names

Conversation

@ujjwalredd
Copy link
Copy Markdown
Contributor

@ujjwalredd Ujjwal Reddy K S (ujjwalredd) commented Apr 2, 2026

Why

The docstring example in filter_messages uses abbreviated kwarg names (incl_names, incl_types, excl_ids) that don't exist on the function signature. The real parameter names are include_names, include_types, and exclude_ids. Anyone copying the example from the docs gets a TypeError with no obvious explanation.

Fixes #36463

What changed

Renamed the three wrong kwarg names in the docstring example to match the actual function signature. No logic touched.

Review notes

Docstring-only change, safe to merge without additional test changes.

@github-actions github-actions bot added core `langchain-core` package issues & PRs fix For PRs that implement a fix size: XS < 50 LOC labels Apr 2, 2026
@github-actions

This comment has been minimized.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Apr 3, 2026

Merging this PR will not alter performance

⚠️ 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.

✅ 13 untouched benchmarks
⏩ 27 skipped benchmarks1


Comparing ujjwalredd:fix/filter-messages-docstring-param-names (03226be) with master (e89afed)

Open in CodSpeed

Footnotes

  1. 27 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@ccurme ccurme (ccurme) merged commit d1529dd into langchain-ai:master Apr 3, 2026
178 of 182 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core `langchain-core` package issues & PRs external fix For PRs that implement a fix new-contributor size: XS < 50 LOC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(core): filter_messages docstring example uses wrong parameter names

3 participants