Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

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

Merged
pradn merged 3 commits into
googleapis:masterfrom
plamut:iss-110
Jun 6, 2020
Merged

docs: fix update subscription/snapshot/topic samples#113
pradn merged 3 commits into
googleapis:masterfrom
plamut:iss-110

Conversation

@plamut

@plamutplamut commented Jun 5, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

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)

@plamutplamut added the type: docs Improvement to the documentation for an API. label Jun 5, 2020
@plamut
plamut requested a review from pradnJune 5, 2020 13:23
@googlebotgooglebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 5, 2020
plamut
plamut commented Jun 5, 2020
View reviewed changes
Comment threadgoogle/cloud/pubsub_v1/gapic/subscriber_client.py Outdated
plamut
plamut commented Jun 5, 2020
View reviewed changes
Comment threadgoogle/cloud/pubsub_v1/gapic/subscriber_client.py Outdated
pradn
pradn suggested changes Jun 5, 2020
View reviewed changes

@pradnpradn left a comment

Copy link
Copy Markdown
Contributor

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.

Comment threadgoogle/cloud/pubsub_v1/gapic/subscriber_client.py Outdated
Comment threadgoogle/cloud/pubsub_v1/gapic/subscriber_client.py Outdated
@plamut
plamut requested a review from pradnJune 6, 2020 10:18
@plamutplamut changed the title docs: fix update subscription/snapshot samplesdocs: fix update subscription/snapshot/topic samplesJun 6, 2020
@pradn
pradn merged commit e62c38b into googleapis:masterJun 6, 2020
@plamut
plamut deleted the iss-110 branch June 7, 2020 06:27
@release-pleaserelease-pleaseBot mentioned this pull request Jun 9, 2020
Merged
gcf-merge-on-greenBot pushed a commit that referenced this pull request Jun 9, 2020
@release-please
chore: release 1.6.0 (#117)
60fe71a
## [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))
@release-pleaserelease-pleaseBot mentioned this pull request Aug 11, 2022
Merged
parthea pushed a commit to googleapis/google-cloud-python that referenced this pull request Mar 2, 2026
@release-please
chore: release 1.6.0 (#117)
61e2b02
## [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](googleapis/python-pubsub#100)) ([cf9e87c](googleapis/python-pubsub@cf9e87c))
- Fix update subscription/snapshot/topic samples ([#113](googleapis/python-pubsub#113)) ([e62c38b](googleapis/python-pubsub@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](googleapis/python-pubsub#114)) ([0132a46](googleapis/python-pubsub@0132a46))
- Incorporate will_accept() checks into publish() ([#108](googleapis/python-pubsub#108)) ([6c7677e](googleapis/python-pubsub@6c7677e))
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer
@pradnpradnpradn approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cla: yesThis human has signed the Contributor License Agreement.type: docsImprovement to the documentation for an API.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs: update_subscription and update_snapshot examples are wrong

3 participants

@plamut@pradn@googlebot