-
Notifications
You must be signed in to change notification settings - Fork 87
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 type for retryCodes #404
Conversation
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed (or fixed any issues), please reply here (e.g. What to do if you already signed the CLAIndividual signers
Corporate signers
|
I signed it! |
CLAs look good, thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's definitely an array of numbers, so approved - but the problem is, I don't believe we actually use these JsDoc-style comments anywhere for now. May I ask what was the use case that made you fix this? ('Just wanted to fix it' is a perfectly valid answer, I'm just curious if there could be other reasons)
I was trying to change retry setting for @google-cloud/pubsub and the documentation for changing these (https://cloud.google.com/nodejs/docs/reference/pubsub/0.23.x/v1.PublisherClient#publish) eventually leads to http://googleapis.github.io/gax-nodejs/global.html#RetryOptions. |
Thank you! It makes perfect sense then. I didn't realize those jsdoc comments are used in the dependent libraries. (I'll make the CI work and will merge this one) |
Fixes misleading documentation