Skip to content

docs(events): remove stale params from handle_llm_stream_chunk docstring - #7313

Merged
Vidit-Ostwal merged 1 commit into
crewAIInc:mainfrom
uoparaji:docs/console-formatter-stream-chunk-docstring
Sep 7, 2026
Merged

docs(events): remove stale params from handle_llm_stream_chunk docstring#7313
Vidit-Ostwal merged 1 commit into
crewAIInc:mainfrom
uoparaji:docs/console-formatter-stream-chunk-docstring

Conversation

@uoparaji

@uoparaji uoparaji commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Related issue

Fixes #7312

Summary

Docstring-only fix in lib/crewai/src/crewai/events/utils/console_formatter.py. The Args: block on ConsoleFormatter.handle_llm_stream_chunk listed chunk and crew_tree parameters that were removed from the signature (which is now (accumulated_text, call_type)). The sole caller — lib/crewai/src/crewai/events/event_listener.py:635 — passes exactly the two real params.

Verification

  • Tests added or updated for the changed behavior — N/A, docstring-only change; no runtime behavior modified.
  • Relevant tests and quality checks pass locally — uv tool run --from ruff==0.15.1 ruff check and ruff format --check on the touched file both pass.

Additional context

Note for triage: this PR was authored with the assistance of Claude Code. Per CONTRIBUTING.md the llm-generated label is required; I don't have permission to apply it from a fork PR, so flagging it here. Issue #7312 already carries the label.

The Args block for ConsoleFormatter.handle_llm_stream_chunk listed
'chunk' and 'crew_tree' parameters that no longer exist on the method.
The signature was refactored to (accumulated_text, call_type) but the
docstring was not updated. Callers in event_listener.py pass only the
two real params.

Refs crewAIInc#7312.
@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: 2995e12a-0077-4305-850e-9c9fec7ef584

📥 Commits

Reviewing files that changed from the base of the PR and between 1f3e611 and 5808ce7.

📒 Files selected for processing (1)
  • lib/crewai/src/crewai/events/utils/console_formatter.py
💤 Files with no reviewable changes (1)
  • lib/crewai/src/crewai/events/utils/console_formatter.py

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

Changes

ConsoleFormatter documentation

Layer / File(s) Summary
Align stream handler documentation
lib/crewai/src/crewai/events/utils/console_formatter.py
The handle_llm_stream_chunk docstring now lists only accumulated_text and call_type. The method signature is unchanged.

Merge Risk: ⚪ Minimal · up to 5808c

This change corrects stale parameter documentation without altering runtime behavior. No current merge-readiness risk is identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description includes the required related issue, summary, verification details, and additional context. It clearly identifies this as a docstring-only change.
Linked Issues check ✅ Passed The change satisfies issue #7312 by removing the obsolete chunk and crew_tree entries from the handle_llm_stream_chunk docstring while retaining the actual parameters.
Out of Scope Changes check ✅ Passed The pull request only changes the targeted docstring. It includes no unrelated or runtime changes.
Title check ✅ Passed The title clearly and concisely describes the removal of stale parameters from the handle_llm_stream_chunk docstring.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Vidit-Ostwal Vidit-Ostwal left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Appreciate this Thanks @uoparaji

@Vidit-Ostwal
Vidit-Ostwal merged commit 1b855b4 into crewAIInc:main Sep 7, 2026
54 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] ConsoleFormatter.handle_llm_stream_chunk docstring lists params that don't exist

2 participants