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

documentation of send_timeout_sec option is missing #3264

Closed
cou929 opened this issue Mar 15, 2021 · 0 comments · Fixed by #14907
Closed

documentation of send_timeout_sec option is missing #3264

cou929 opened this issue Mar 15, 2021 · 0 comments · Fixed by #14907
Labels
type: docs Improvement to the documentation for an API.

Comments

@cou929
Copy link

cou929 commented Mar 15, 2021

There is a send_timeout_sec option but there doesn't seem to be any documentation of the option.

$ ri Google::Apis::ClientOptions.default
= Google::Apis::ClientOptions.default

(from gem google-apis-core-0.3.0)
=== Implementation from ClientOptions
------------------------------------------------------------------------
  default()

------------------------------------------------------------------------

@!attribute [rw] application_name
  @return [String] Name of the application, for identification in the User-Agent header

@!attribute [rw] application_version
  @return [String] Version of the application, for identification in the User-Agent header

@!attribute [rw] proxy_url
  @return [String] URL of a proxy server

@!attribute [rw] log_http_requests
  @return [Boolean] True if raw HTTP requests should be logged

@!attribute [rw] open_timeout_sec
  @return [Fixnum] How long, in seconds, before failed connections time out

@!attribute [rw] read_timeout_sec
  @return [Fixnum] How long, in seconds, before requests time out

@!attribute [rw] transparent_gzip_decompression @return [Boolean] True
if gzip compression needs to be enabled Get the default options @return
[Google::Apis::ClientOptions]

Environment details

  • OS: MacOSX 10.15.5
  • Ruby version: ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin19]
  • Gem name and version: google-apis-core (0.3.0)

Steps to reproduce

  1. gem rdoc google-apis-core
  2. ri Google::Apis::ClientOptions.default

Code example

n/a

@dazuma dazuma added the type: docs Improvement to the documentation for an API. label Mar 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants