Skip to content

Clarify ThreadPoolExecutor#kill documentation - #1111

Open
oiahoon wants to merge 1 commit into
ruby-concurrency:masterfrom
oiahoon:docs/clarify-executor-kill
Open

Clarify ThreadPoolExecutor#kill documentation#1111
oiahoon wants to merge 1 commit into
ruby-concurrency:masterfrom
oiahoon:docs/clarify-executor-kill

Conversation

@oiahoon

@oiahoon oiahoon commented Aug 17, 2026

Copy link
Copy Markdown

Summary

  • clarify that executor #kill may interrupt in-progress tasks
  • keep the existing queued-task and new-task guarantees explicit
  • add the required changelog entry

Closes #1072

Verification

  • bundle exec rspec spec/concurrent/executor/fixed_thread_pool_spec.rb spec/concurrent/executor/simple_executor_service_spec.rb (110 examples, 0 failures)
  • deterministic FixedThreadPool#kill runtime check
  • BUNDLE_WITH=documentation bundle exec rake yard:master
  • bundle exec rake (2,795/2,796 examples passed; the timing-sensitive channel integration example that failed once passed on focused rerun)
  • git diff --check

@eregon eregon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good, one change needed though

Comment thread CHANGELOG.md Outdated
Comment on lines +3 to +6
concurrent-ruby:

* (#1072) Clarify that executor `#kill` may interrupt in-progress tasks.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

In recent releases we just link to GitHub releases to avoid duplication and extra work, could you therefore undo this change?

@eregon

eregon commented Aug 19, 2026

Copy link
Copy Markdown
Member

Since this is @!macro executor_service_method_kill did you check all usages of this macro are indeed killing the Thread (Thread#kill)?

@oiahoon
oiahoon force-pushed the docs/clarify-executor-kill branch from 8d8ee9c to 66b5cab Compare August 20, 2026 04:10
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.

ThreadPoolExecutor#kill: documentation and implementation are out of sync

2 participants