mirror of
https://github.com/rest-client/rest-client.git
synced 2022-11-09 13:49:40 -05:00
Minor doc related changes.
This commit is contained in:
parent
92872e10b5
commit
10d3599745
2 changed files with 3 additions and 4 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -5,3 +5,4 @@
|
||||||
/doc
|
/doc
|
||||||
/pkg
|
/pkg
|
||||||
/rdoc
|
/rdoc
|
||||||
|
/.yardoc
|
||||||
|
|
|
@ -38,8 +38,6 @@ module RestClient
|
||||||
# called with the HTTP request and request params.
|
# called with the HTTP request and request params.
|
||||||
class Request
|
class Request
|
||||||
|
|
||||||
# TODO: rename timeout to read_timeout
|
|
||||||
|
|
||||||
attr_reader :method, :uri, :url, :headers, :cookies, :payload, :proxy,
|
attr_reader :method, :uri, :url, :headers, :cookies, :payload, :proxy,
|
||||||
:user, :password, :read_timeout, :max_redirects,
|
:user, :password, :read_timeout, :max_redirects,
|
||||||
:open_timeout, :raw_response, :processed_headers, :args,
|
:open_timeout, :raw_response, :processed_headers, :args,
|
||||||
|
@ -495,8 +493,8 @@ module RestClient
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
# Parse the @url string into a URI object using #parse_url and save it as
|
# Parse the `@url` string into a URI object using #parse_url and save it as
|
||||||
# @uri. Also save any basic auth user or password as @user and @password.
|
# `@uri`. Also save any basic auth user or password as @user and @password.
|
||||||
# If no auth info was passed, check for credentials in a Netrc file.
|
# If no auth info was passed, check for credentials in a Netrc file.
|
||||||
#
|
#
|
||||||
# @param [String] url A URL string.
|
# @param [String] url A URL string.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue