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

Add a link to client library howto to the README template #1351

Open
tmatsuo opened this issue Feb 9, 2022 · 3 comments
Open

Add a link to client library howto to the README template #1351

tmatsuo opened this issue Feb 9, 2022 · 3 comments
Assignees
Labels
lang: nodejs Issues specific to JavaScript or TypeScript. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@tmatsuo
Copy link
Contributor

tmatsuo commented Feb 9, 2022

The README in our client libraries doesn't provide a document for how to customize client library's behavior (timeout, retry, etc). I suggest we add a link to the Client Library Howto in the READMEs (if that document is not permanent, we can use a specific commit hash).

Here's a draft:

This library is built on top of google-gax. To customize the common behavior of this client library (timeout, retry, etc), see Client Library Howto.

@tmatsuo tmatsuo added the type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. label Feb 9, 2022
@tmatsuo tmatsuo self-assigned this Feb 9, 2022
@bcoe
Copy link
Contributor

bcoe commented Feb 9, 2022

I think setting the timeout on a single RPC call is a pretty common customization, and I often forget how to do it. Having a blurb along with an exmaple I think would be good, just a small snippet below the blurb.

@bcoe
Copy link
Contributor

bcoe commented Feb 9, 2022

I would put this directly below.

Supported Node.js Versions

Perhaps in

Advanced configuration

@summer-ji-eng
Copy link
Contributor

summer-ji-eng commented Feb 9, 2022

Modified the sentence a bit.

This library is built on top of google-gax as its transport layer. To customize the common behavior of this client library (timeout, retry, etc), see [Client Library Howto](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md).

I suggest we could add in section:

Using the client library
...
[Insert here]

Samples

@chingor13 chingor13 added the lang: nodejs Issues specific to JavaScript or TypeScript. label May 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lang: nodejs Issues specific to JavaScript or TypeScript. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests

4 participants