Added example for generating request.

git-svn-id: https://google-api-ruby-client.googlecode.com/svn/trunk@45 c1d61fac-ed7f-fcc1-18f7-ff78120a04ef
datemyschool · Oct 7, 2010 · c674447 · c674447
1 parent de394a5
commit c674447
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/google/api_client.rb b/lib/google/api_client.rb
@@ -245,6 +245,14 @@ def latest_service(service_name)
     #     otherwise.  Defaults to <code>true</code>.
     #
     # @return [Array] The generated request.
+    #
+    # @example
+    #   request = client.generate_request(
+    #     'chili.activities.list',
+    #     {'scope' => '@self', 'userId' => '@me', 'alt' => 'json'},
+    #     '', [], {:signed => true}
+    #   )
+    #   method, uri, headers, body = request
     def generate_request(
         api_method, parameters={}, body='', headers=[], options={})
       options={