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

Pub/Sub: document regional endpoint #8789

Merged
merged 2 commits into from
Jul 26, 2019
Merged

Conversation

anguillanneuf
Copy link
Contributor

@anguillanneuf anguillanneuf commented Jul 25, 2019

Please comment if this is enough documentation for showing how to configure regional endpoint.

I could take this opportunity to document other kwargs if needed, but it's recommended that users don't touch those.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jul 25, 2019
Copy link
Contributor

@plamut plamut left a comment

Choose a reason for hiding this comment

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

Please comment on if this is enough documentation on regional endpoint re configuring it.
Depends on who reported this, what level of detail is expected?

In a vacuum, the addition looks fine to me. Perhaps just make it a tad more clear with an example?

... single key-value pair of name `api_endpoint`, e.g. `client_options={"api_endpoint": REGIONAL_ENDPOINT}`

@tseaver tseaver added api: pubsub Issues related to the Pub/Sub API. type: docs Improvement to the documentation for an API. labels Jul 26, 2019
Copy link
Contributor

@plamut plamut left a comment

Choose a reason for hiding this comment

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

LGTM

@anguillanneuf anguillanneuf merged commit 03aabdd into master Jul 26, 2019
@anguillanneuf anguillanneuf deleted the regional_endpoints branch July 26, 2019 17:23
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.

4 participants