Skip to content

docs(events): drop stale params from handle_llm_stream_chunk docstring - #7320

Closed
simpleqt wants to merge 1 commit into
crewAIInc:mainfrom
simpleqt:docs/console-formatter-stream-args
Closed

docs(events): drop stale params from handle_llm_stream_chunk docstring#7320
simpleqt wants to merge 1 commit into
crewAIInc:mainfrom
simpleqt:docs/console-formatter-stream-args

Conversation

@simpleqt

@simpleqt simpleqt commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

ConsoleFormatter.handle_llm_stream_chunk(self, accumulated_text, call_type=None)'s Args block documents chunk and crew_tree — neither is a parameter. The block now matches the signature.

(Note: this PR was prepared with AI assistance — happy to see it labeled llm-generated per the contributing guidelines.)

The Args block documented 'chunk' and 'crew_tree'; the signature takes
only accumulated_text and call_type.
Copilot AI lite review requested due to automatic review settings September 7, 2026 16:38

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Thanks for the pull request.

First-time contributors need an associated open issue before we can review a PR.

  1. Open an issue with a template, or pick an existing open one.
  2. Open a new PR (or reopen this one) whose title or body mentions that issue, for example #123.

See the contributing guide.

@github-actions github-actions Bot closed this Sep 7, 2026
@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: 384cf2e2-c570-4047-80f0-731d3ae46cc5

📥 Commits

Reviewing files that changed from the base of the PR and between 1b855b4 and 2b874a8.

📒 Files selected for processing (1)
  • lib/crewai/src/crewai/events/utils/console_formatter.py

📝 Walkthrough

Walkthrough

The change removes obsolete chunk and crew_tree parameter documentation from handle_llm_stream_chunk. The method signature and implementation remain unchanged.

Changes

Documentation cleanup

Layer / File(s) Summary
Update method documentation
lib/crewai/src/crewai/events/utils/console_formatter.py
The handle_llm_stream_chunk documentation no longer describes chunk and crew_tree. Documentation for accumulated_text and call_type remains.
✨ 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.

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.

2 participants