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

docs: fix update subscription/snapshot/topic samples #113

Merged
merged 3 commits into from Jun 6, 2020

Conversation

plamut
Copy link
Contributor

@plamut plamut commented Jun 5, 2020

Fixes #110.

This PR fixes two samples in subscriber docstrings. Ideally, this should be addressed in the code generator itself, but until then we can fix this manually on the PubSub side.

I did not re-generate all files due to the current issue with docstring format, thus the PR only includes the relevant changes in the generated code.

PR checklist

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

@plamut plamut added the type: docs Improvement to the documentation for an API. label Jun 5, 2020
@plamut plamut requested a review from pradn June 5, 2020 13:23
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 5, 2020
Copy link
Contributor

@pradn pradn left a comment

Choose a reason for hiding this comment

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

Thanks for taking this on! While you're at it, can you please update the docs for "update_topic" as well? They're incomplete as of now.

google/cloud/pubsub_v1/gapic/subscriber_client.py Outdated Show resolved Hide resolved
google/cloud/pubsub_v1/gapic/subscriber_client.py Outdated Show resolved Hide resolved
@plamut plamut requested a review from pradn June 6, 2020 10:18
@plamut plamut changed the title docs: fix update subscription/snapshot samples docs: fix update subscription/snapshot/topic samples Jun 6, 2020
@pradn pradn merged commit e62c38b into googleapis:master Jun 6, 2020
@plamut plamut deleted the iss-110 branch June 7, 2020 06:27
@release-please release-please bot mentioned this pull request Jun 9, 2020
gcf-merge-on-green bot pushed a commit that referenced this pull request Jun 9, 2020
## [1.6.0](https://www.github.com/googleapis/python-pubsub/compare/v1.5.0...v1.6.0) (2020-06-09)

### Features

* Add flow control for message publishing ([#96](https://www.github.com/googleapis/python-pubsub/issues/96)) ([06085c4](https://www.github.com/googleapis/python-pubsub/commit/06085c4083b9dccdd50383257799904510bbf3a0))


### Bug Fixes

* Fix PubSub incompatibility with api-core 1.17.0+ ([#103](https://www.github.com/googleapis/python-pubsub/issues/103)) ([c02060f](https://www.github.com/googleapis/python-pubsub/commit/c02060fbbe6e2ca4664bee08d2de10665d41dc0b))


### Documentation
- Clarify that Schedulers shouldn't be used with multiple SubscriberClients ([#100](#100)) ([cf9e87c](cf9e87c))
- Fix update subscription/snapshot/topic samples ([#113](#113)) ([e62c38b](e62c38b))


### Internal / Testing Changes
- Re-generated service implementaton using synth: removed experimental notes from the RetryPolicy and filtering features in anticipation of GA, added DetachSubscription (experimental) ([#114](#114)) ([0132a46](0132a46))
- Incorporate will_accept() checks into publish() ([#108](#108)) ([6c7677e](6c7677e))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

docs: update_subscription and update_snapshot examples are wrong
3 participants