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 type for retryCodes #404

Merged
merged 2 commits into from
Feb 1, 2019
Merged

docs: fix type for retryCodes #404

merged 2 commits into from
Feb 1, 2019

Conversation

mkls
Copy link
Contributor

@mkls mkls commented Jan 31, 2019

Fixes misleading documentation

  • Tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

@googlebot
Copy link

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. I signed it!) and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

@googlebot googlebot added the cla: no This human has *not* signed the Contributor License Agreement. label Jan 31, 2019
@mkls
Copy link
Contributor Author

mkls commented Jan 31, 2019

I signed it!

@googlebot
Copy link

CLAs look good, thanks!

@googlebot googlebot added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Jan 31, 2019
@JustinBeckwith JustinBeckwith changed the title docu: fix type for retryCodes docs: fix type for retryCodes Jan 31, 2019
Copy link
Contributor

@alexander-fenster alexander-fenster left a 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)

@alexander-fenster alexander-fenster added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@mkls
Copy link
Contributor Author

mkls commented Jan 31, 2019

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.
I figured this is an auto generated documentation, and changing this jsdoc comments would fix it.

@alexander-fenster
Copy link
Contributor

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)

@alexander-fenster alexander-fenster added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@alexander-fenster alexander-fenster added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@alexander-fenster alexander-fenster added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@alexander-fenster alexander-fenster added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@alexander-fenster alexander-fenster added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 31, 2019
@alexander-fenster alexander-fenster added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Feb 1, 2019
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Feb 1, 2019
@alexander-fenster alexander-fenster merged commit 1c7cdf6 into googleapis:master Feb 1, 2019
mkls referenced this pull request in googleapis/nodejs-pubsub Mar 12, 2019
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants