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.

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

PubSub: Document different PubSub received message types #8468

Merged
merged 1 commit into from
Jun 24, 2019

Conversation

plamut
Copy link
Contributor

@plamut plamut commented Jun 24, 2019

Closes #7128.

This PR documents different PubSub received message types depending on whether a synchronous or asynchronous method is used to pull messages.

Disclaimer: I was not able to generate the docs locally due to network timeouts when downloading intersphinx inventory files from external sources. Please double check that the generated intra-doc links work.

How to test

Steps to perform:

  • Generate the pubsub docs locally (from inside the pubsub/ directory):
    $ nox -f noxfile.py -s docs
    
  • Open the generated docs for subscriber:
    $ google-chrome "file://$GOOG_CLOUD_PYTHON_DIR/pubsub/docs/_build/html//subscriber/index.html"
    

Expected result:
The different received message type are clearly described, the code samples are valid, and the intra-doc links work.

@plamut plamut added api: pubsub Issues related to the Pub/Sub API. type: docs Improvement to the documentation for an API. labels Jun 24, 2019
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 24, 2019
@plamut plamut changed the title PubSub: Document different PuSub received message types PubSub: Document different PubSub received message types Jun 24, 2019
@plamut
Copy link
Contributor Author

plamut commented Jun 24, 2019

@enugentdt As the issue reporter, do you the docs changes here in this PR clear enough to answer all the questions you had when opening the issue?

Copy link
Contributor

@anguillanneuf anguillanneuf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@sduskis sduskis merged commit 20f83b1 into googleapis:master Jun 24, 2019
@plamut plamut deleted the iss-7128 branch June 24, 2019 17:35
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: Inconsistent documentation on received message types
4 participants