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.

Sign up for GitHub

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

Jump to bottom

Retry settings sample needs clarification about settings object #1952

Closed
feywind opened this issue Jul 8, 2024 · 1 comment
Closed

Retry settings sample needs clarification about settings object #1952

feywind opened this issue Jul 8, 2024 · 1 comment
Assignees
@feywind
Labels
api: pubsub Issues related to the googleapis/nodejs-pubsub API. priority: p3 Desirable enhancement or fix. May not be included in next release. samples Issues that are directly related to samples. type: docs Improvement to the documentation for an API.

Comments

@feywind
Copy link
Collaborator

feywind commented Jul 8, 2024

In this sample...

https://github.com/googleapis/nodejs-pubsub/blob/main/samples/typescript/publishWithRetrySettings.ts

We are showing the full, original object and documenting what each setting does. However, it's not obvious at all that this entire structure will replace the original in gax. It's easy to end up in a situation where a bunch of the settings get set to zero. This should be improved.

The defaults shown are also old at this point and should be updated.
@feywind feywind added type: docs Improvement to the documentation for an API. priority: p3 Desirable enhancement or fix. May not be included in next release. labels Jul 8, 2024
@feywind feywind self-assigned this Jul 8, 2024
@product-auto-label product-auto-label bot added api: pubsub Issues related to the googleapis/nodejs-pubsub API. samples Issues that are directly related to samples. labels Jul 8, 2024
@feywind
Copy link
Collaborator Author

feywind commented Oct 18, 2024

Fixed by #1987

@feywind feywind closed this as completed Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@feywind feywind

Labels
api: pubsub Issues related to the googleapis/nodejs-pubsub API. priority: p3 Desirable enhancement or fix. May not be included in next release. samples Issues that are directly related to samples. type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@feywind