Pubsub: Separate subscriber and publish future documentation. #8205
Conversation
This file contains 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
googlebot
added
the
cla: yes
|
TODO: add test for publish future. |
tseaver
added
api: pubsub
tseaver
suggested changes
Jun 3, 2019
| err = self.exception(timeout=timeout) | ||
| if err is None: | ||
| return self._result | ||
| raise err |
There was a problem hiding this comment.
This new method needs unit tests (one for the error case, one for the normal one).
tseaver
changed the title
tseaver
approved these changes
Jun 4, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This closes #7816.
This PR aims to fix the docstrings for certain methods on
pubsub_v1.publisher.futures.Futureandpubsub_v1.subscriber.futures.StreamingPullFuture. There are cases where the methods would share the same docstrings, but that's not always true. For example, callingresult()on a publish future should return a message ID, but calling it on a StreamingPullFuture doesn't return a value, it simply keeps the RPC channel open for receiving messages.