Surface information about the generated default timeout/retry parameters in the per-method comments #679
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.
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.
The text was updated successfully, but these errors were encountered: