Merge pull request #948 from lostisland/document-example

[documentation] RackBuilder example, params
This commit is contained in:
risk danger olson 2019-03-20 16:34:33 -06:00 committed by GitHub
commit ffc6911ed3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,6 +6,7 @@ module Faraday
# A Builder that processes requests into responses by passing through an inner # A Builder that processes requests into responses by passing through an inner
# middleware stack (heavily inspired by Rack). # middleware stack (heavily inspired by Rack).
# #
# @example
# Faraday::Connection.new(url: 'http://sushi.com') do |builder| # Faraday::Connection.new(url: 'http://sushi.com') do |builder|
# builder.request :url_encoded # Faraday::Request::UrlEncoded # builder.request :url_encoded # Faraday::Request::UrlEncoded
# builder.adapter :net_http # Faraday::Adapter::NetHttp # 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 # Processes a Request into a Response by passing it through this Builder's
# middleware stack. # middleware stack.
# #
# connection - Faraday::Connection # @param connection [Faraday::Connection]
# request - Faraday::Request # @param request [Faraday::Request]
# #
# Returns a Faraday::Response. # @return [Faraday::Response]
def build_response(connection, request) def build_response(connection, request)
app.call(build_env(connection, request)) app.call(build_env(connection, request))
end end