Skip to content

docs: include_hook_events names the SessionStart and Setup events the CLI emits regardless - #1336

Open
codyanthony736 wants to merge 1 commit into
anthropics:mainfrom
codyanthony736:include-hook-events-docstring
Open

codyanthony736 wants to merge 1 commit into
anthropics:mainfrom
codyanthony736:include-hook-events-docstring

Conversation

@codyanthony736

Copy link
Copy Markdown
Contributor

Summary

Docstring-only change; no behavior change. ClaudeAgentOptions.include_hook_events says it matches the TypeScript SDK's includeHookEvents, whose doc comment adds that the SessionStart and Setup hook events are emitted regardless of the setting. The Python docstring now says the same.

Confirmed against 0.2.160 in a container: with include_hook_events=False and a project-level SessionStart hook configured, the message stream still carries HookEventMessage items for SessionStart; with the flag on, the same items appear.

Line reference at main 37422c2.

… CLI emits regardless

Docstring-only change. The option says it matches the TypeScript SDK's
includeHookEvents, whose doc comment adds that the SessionStart and Setup
hook events are emitted regardless of the setting. Confirmed against
0.2.160: with include_hook_events=False and a project-level SessionStart
hook configured, the stream still carries HookEventMessage items for
SessionStart.
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@37422c2). Learn more about missing BASE report.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1336   +/-   ##
=======================================
  Coverage        ?   92.21%           
=======================================
  Files           ?       25           
  Lines           ?     4648           
  Branches        ?        0           
=======================================
  Hits            ?     4286           
  Misses          ?      362           
  Partials        ?        0           
Flag Coverage Δ
mcp-v1-floor 91.82% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

This branch has not been deployed

No deployments
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