Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Pub/Sub: wrong inherited documentation for StreamingPullFuture #7816

Closed
anguillanneuf opened this issue Apr 29, 2019 · 0 comments · Fixed by #8205
Closed

Pub/Sub: wrong inherited documentation for StreamingPullFuture #7816

anguillanneuf opened this issue Apr 29, 2019 · 0 comments · Fixed by #8205
Assignees
@anguillanneuf
Labels
api: pubsub Issues related to the Pub/Sub API. triaged for GA type: docs Improvement to the documentation for an API.

Comments

@anguillanneuf
Copy link
Contributor

anguillanneuf commented Apr 29, 2019 •
edited
Loading

The documentation for StreamingPullFuture's methods like result() and exception() doesn't make sense because it describes Publish futures not streaming pull futures.

StreamingPullFuture inherits futures.Future, that's where the "wrong" documentation got carried over.
@anguillanneuf anguillanneuf added type: docs Improvement to the documentation for an API. api: pubsub Issues related to the Pub/Sub API. labels Apr 29, 2019
@anguillanneuf anguillanneuf mentioned this issue May 31, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@anguillanneuf anguillanneuf

Labels
api: pubsub Issues related to the Pub/Sub API. triaged for GA type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Pubsub: Separate subscriber and publish future documentation. googleapis/google-cloud-python
2 participants
@sduskis @anguillanneuf