docs(pubsub): Add subscriber shutdown documentation and examples - #36482
Draft
aandreassa wants to merge 1 commit into
Draft
docs(pubsub): Add subscriber shutdown documentation and examples#36482aandreassa wants to merge 1 commit into
aandreassa wants to merge 1 commit into
Conversation
aandreassa
force-pushed
the
pubsub-shutdown-docs
branch
from
August 28, 2026 01:12
2e6d8d0 to
93d2b7c
Compare
1. Added a **Subscriber Shutdown Options** section to `README.md` demonstrating `:wait_for_processing`, `:nack_immediately`, and `shutdown_timeout: 30`. 2. Added YARD `@example` blocks on `Subscriber#listen` in `subscriber.rb` illustrating immediate nack on shutdown and custom timeout usage. 3. Verified documentation generation via `rake yard` and `rake doctest`.
aandreassa
force-pushed
the
pubsub-shutdown-docs
branch
from
August 28, 2026 21:58
93d2b7c to
f710d91
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation and code examples for subscriber shutdown options:
README.mddemonstrating:wait_for_processing,:nack_immediately, andshutdown_timeout: 30.@exampleblocks onSubscriber#listeninsubscriber.rbillustrating immediate nack on shutdown and custom timeout usage.rake yardandrake doctest.