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

Surface information about the generated default timeout/retry parameters in the per-method comments #679

Open
viacheslav-rostovtsev opened this issue Sep 29, 2021 · 0 comments
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@viacheslav-rostovtsev
Copy link
Member

This is brought on by googleapis/google-cloud-ruby#14050

The end-user does not know about the default per-rpc timeout being generated, so they just percieve the client-wide timeout to 'not have any effect'.
I propose that if we generate default timeout/retry/etc information for the method, we also add comments to the method description saying essentially,
"this method has such-and-such settings configured by default, the client-wide configuration won't override these settings".
@quartzmo suggested having a small table with the configured settings, and I think it's a great idea if we can pull it off to be consistent in all forms of documentation.

@viacheslav-rostovtsev viacheslav-rostovtsev added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. priority: p3 Desirable enhancement or fix. May not be included in next release. labels Sep 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests

1 participant