fix(core): correct parameter names in filter_messages docstring example#36462
Merged
ccurme (ccurme) merged 1 commit intolangchain-ai:masterfrom Apr 3, 2026
Conversation
This comment has been minimized.
This comment has been minimized.
8 tasks
Merging this PR will not alter performance
|
ccurme (ccurme)
approved these changes
Apr 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The docstring example in
filter_messagesuses abbreviated kwarg names (incl_names,incl_types,excl_ids) that don't exist on the function signature. The real parameter names areinclude_names,include_types, andexclude_ids. Anyone copying the example from the docs gets aTypeErrorwith 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.