Skip to content

fix: remove outdated stop_and_shutdown_loop from Worker docstring#673

Open
nightcityblade wants to merge 2 commits into
faust-streaming:masterfrom
nightcityblade:fix/issue-317
Open

fix: remove outdated stop_and_shutdown_loop from Worker docstring#673
nightcityblade wants to merge 2 commits into
faust-streaming:masterfrom
nightcityblade:fix/issue-317

Conversation

@nightcityblade

Copy link
Copy Markdown
Contributor

Description

Fixes #317

The Worker class docstring referenced stop_and_shutdown_loop() in example 3, but this method no longer exists. The Worker registers signal handlers on start, so explicit cleanup in a finally block is unnecessary.

Removed the outdated try/finally block and the reference to stop_and_shutdown_loop() from the docstring example.

@nightcityblade

Copy link
Copy Markdown
Contributor Author

Gentle ping — any thoughts on this? Happy to address feedback if needed.

@codecov

codecov Bot commented Jul 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.09%. Comparing base (c3c4244) to head (1928bd1).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #673   +/-   ##
=======================================
  Coverage   94.09%   94.09%           
=======================================
  Files         102      102           
  Lines       11108    11108           
  Branches     1198     1198           
=======================================
  Hits        10452    10452           
  Misses        557      557           
  Partials       99       99           

☔ 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.

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.

Worker docstring incorrect, stop_and_shutdown_loop doesn't exist anymore

2 participants