From 7d370c6d10e4c5f4dccddb01460201bd13f366b3 Mon Sep 17 00:00:00 2001 From: Bob Aman Date: Thu, 12 May 2011 17:12:15 +0000 Subject: [PATCH] Updated documentation on User-Agent. git-svn-id: https://google-api-ruby-client.googlecode.com/svn/trunk@154 c1d61fac-ed7f-fcc1-18f7-ff78120a04ef --- lib/google/api_client.rb | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lib/google/api_client.rb b/lib/google/api_client.rb index 50c305b66..1b6150727 100644 --- a/lib/google/api_client.rb +++ b/lib/google/api_client.rb @@ -43,10 +43,13 @@ module Google # # @option options [String] :host ("www.googleapis.com") # The API hostname used by the client. This rarely needs to be changed. - # @option options [String] :user_agent ("google-api-ruby-client/{version}") + # @option options [String] :application_name + # The name and version of the application using the client. This should + # be given in the form `"{name}/{version}"`. + # @option options [String] :user_agent + # ("{app_name} google-api-ruby-client/{version} {os_name}/{os_version}") # The user agent used by the client. Most developers will want to - # leave this value alone — the API key is the primary mechanism used to - # identify an application. + # leave this value alone and use the `:application_name` option instead. def initialize(options={}) # Normalize key to String to allow indifferent access. options = options.inject({}) do |accu, (key, value)|