Improve commentgitaly-call-kwargs

1 files changed, 10 insertions, 2 deletions

diff --git a/lib/gitlab/gitaly_client.rb b/lib/gitlab/gitaly_client.rb
index c1a64d04307..6c1ae19ff11 100644
--- a/lib/gitlab/gitaly_client.rb
+++ b/lib/gitlab/gitaly_client.rb
@@ -70,10 +70,18 @@ module Gitlab
 
     # All Gitaly RPC call sites should use GitalyClient.call. This method
     # makes sure that per-request authentication headers are set.
-    # 
+    #
     # This method optionally takes a block which receives the keyword
     # arguments hash 'kwargs' that will be passed to gRPC. This allows the
-    # caller to modify or augment the keyword arguments.
+    # caller to modify or augment the keyword arguments. The block must
+    # return a hash.
+    #
+    # For example:
+    #
+    # GitalyClient.call(storage, service, rpc, request) do |kwargs|
+    #   kwargs.merge(deadline: Time.now + 10)
+    # end
+    #
     def self.call(storage, service, rpc, request)
       enforce_gitaly_request_limits(:call)