PubSub: Link to correct TimeoutError in futures docs #9216
Merged
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.
Closes #9215.
This PR fixes the futures methods' docs that pointed to an incorrect
TimeoutError
exception docs. The docs now correctly point toconcurrent.futures.TimeoutError
, as this is what the code actually raises.I opted to specify the exact exception class directly, rather than using
~.pubsub_v1.TimeoutError
- the latter does not find the actual exception class through the chain of imports within the pubsub package.How to test
Generate the PubSub docs locally, and verify that publisher's and subscriber's futures classes both point to the correct
TimeoutError
class (in the docs for theresult()
andexception()
methods).