Skip to content

Pub/Sub: update docstrings for client kwargs and fix return types uris#9037

Merged
plamut merged 6 commits into
masterfrom
pubsub_docs
Aug 18, 2019
Merged

Pub/Sub: update docstrings for client kwargs and fix return types uris#9037
plamut merged 6 commits into
masterfrom
pubsub_docs

Conversation

@anguillanneuf

@anguillanneuf anguillanneuf commented Aug 16, 2019

Copy link
Copy Markdown
Contributor

Show examples of how to create

  • publisher client with optional batch settings, retry settings, regional endpoints
  • subscriber client with regional endpoints

Fix return types for

  • publish(), from_service_account_file(), list_topics(), list_topic_subscriptions()
  • subscribe(), from_service_account_file(), list_subscriptions(), list_snapshots()

@anguillanneuf anguillanneuf requested a review from plamut as a code owner August 16, 2019 00:44
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Aug 16, 2019
@plamut plamut added type: docs Improvement to the documentation for an API. api: pubsub Issues related to the Pub/Sub API. labels Aug 16, 2019

@plamut plamut 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.

Do we want to mention client_config kwarg in subscriber client's docstring as well for consistency?

Apart of that it looks good, just please fix some redundant whitespace in the docstrings to make the linter happy.

@anguillanneuf

Copy link
Copy Markdown
Contributor Author

Thanks @plamut! Unlike publish with retry settings, for subscriber client, we don't expose retry settings in client_config. If you look closely, client_config in the GAPIC subscriber client is actually in a deprecated state.

@anguillanneuf anguillanneuf changed the title Pub/Sub: update kwargs documentation for publisher and subscriber client Pub/Sub: update docstrings Aug 16, 2019
@anguillanneuf anguillanneuf changed the title Pub/Sub: update docstrings Pub/Sub: update docstrings for client kwargs and fix return types uris Aug 16, 2019
@anguillanneuf anguillanneuf requested a review from plamut August 16, 2019 23:51

@plamut plamut 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.

Looks good, and thanks for the additional cleanup.

@plamut plamut merged commit 8998983 into master Aug 18, 2019
@anguillanneuf anguillanneuf deleted the pubsub_docs branch August 19, 2019 17:57
emar-kar pushed a commit to MaxxleLLC/google-cloud-python that referenced this pull request Sep 18, 2019
googleapis#9037)

* Update kwargs docs

* lint

* Fix return object type

* Put back changes in setup.cfg and noxfile.py

* fix no new line

* fix various return types uris
parthea pushed a commit that referenced this pull request Mar 2, 2026
#9037)

* Update kwargs docs

* lint

* Fix return object type

* Put back changes in setup.cfg and noxfile.py

* fix no new line

* fix various return types uris
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.

3 participants