Skip to content

PubSub: Link to correct TimeoutError in futures docs#9216

Merged
plamut merged 1 commit into
googleapis:masterfrom
plamut:iss-9215
Sep 12, 2019
Merged

PubSub: Link to correct TimeoutError in futures docs#9216
plamut merged 1 commit into
googleapis:masterfrom
plamut:iss-9215

Conversation

@plamut

@plamut plamut commented Sep 12, 2019

Copy link
Copy Markdown
Contributor

Closes #9215.

This PR fixes the futures methods' docs that pointed to an incorrect TimeoutError exception docs. The docs now correctly point to concurrent.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 the result() and exception() methods).

@plamut plamut added api: pubsub Issues related to the Pub/Sub API. type: docs Improvement to the documentation for an API. labels Sep 12, 2019
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 12, 2019
@plamut plamut merged commit 5b80023 into googleapis:master Sep 12, 2019
emar-kar pushed a commit to MaxxleLLC/google-cloud-python that referenced this pull request Sep 18, 2019
emar-kar pushed a commit to MaxxleLLC/google-cloud-python that referenced this pull request Sep 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: pubsub Issues related to the Pub/Sub API. cla: yes This human has signed the Contributor License Agreement. type: docs Improvement to the documentation for an API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

PubSub: Publisher Futures result TimeOutError documentation is not matched with the code

3 participants