From 5b924852fb8f2bb7f84ef007cfd53ec1c00680a6 Mon Sep 17 00:00:00 2001 From: Olle Jonsson Date: Mon, 18 Mar 2019 14:46:33 +0100 Subject: [PATCH] YARD comment for RackBuilder example --- lib/faraday/rack_builder.rb | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/lib/faraday/rack_builder.rb b/lib/faraday/rack_builder.rb index 4f1698c3..8d504024 100644 --- a/lib/faraday/rack_builder.rb +++ b/lib/faraday/rack_builder.rb @@ -6,6 +6,7 @@ module Faraday # A Builder that processes requests into responses by passing through an inner # middleware stack (heavily inspired by Rack). # + # @example # Faraday::Connection.new(url: 'http://sushi.com') do |builder| # builder.request :url_encoded # Faraday::Request::UrlEncoded # builder.adapter :net_http # Faraday::Adapter::NetHttp @@ -144,10 +145,10 @@ module Faraday # Processes a Request into a Response by passing it through this Builder's # middleware stack. # - # connection - Faraday::Connection - # request - Faraday::Request + # @param connection [Faraday::Connection] + # @param request [Faraday::Request] # - # Returns a Faraday::Response. + # @return [Faraday::Response] def build_response(connection, request) app.call(build_env(connection, request)) end