Skip to content

Commit 099b662

Browse files
authored
Merge pull request #118 from BurdetteLamar/http_doc
[DOC] Enhanced RDoc for Net::HTTP
2 parents f8b6b76 + e65a3d9 commit 099b662

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

lib/net/http.rb

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1472,12 +1472,15 @@ def proxy_class?
14721472
attr_reader :proxy_pass
14731473
end
14741474

1475-
# True if requests for this connection will be proxied
1475+
# Returns +true+ if a proxy server is defined, +false+ otherwise;
1476+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
14761477
def proxy?
14771478
!!(@proxy_from_env ? proxy_uri : @proxy_address)
14781479
end
14791480

1480-
# True if the proxy for this connection is determined from the environment
1481+
# Returns +true+ if the proxy server is defined in the environment,
1482+
# +false+ otherwise;
1483+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
14811484
def proxy_from_env?
14821485
@proxy_from_env
14831486
end
@@ -1491,7 +1494,8 @@ def proxy_uri # :nodoc:
14911494
@proxy_uri || nil
14921495
end
14931496

1494-
# The address of the proxy server, if one is configured.
1497+
# Returns the address of the proxy server, if defined, +nil+ otherwise;
1498+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
14951499
def proxy_address
14961500
if @proxy_from_env then
14971501
proxy_uri&.hostname
@@ -1500,7 +1504,8 @@ def proxy_address
15001504
end
15011505
end
15021506

1503-
# The port of the proxy server, if one is configured.
1507+
# Returns the port number of the proxy server, if defined, +nil+ otherwise;
1508+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
15041509
def proxy_port
15051510
if @proxy_from_env then
15061511
proxy_uri&.port
@@ -1509,7 +1514,8 @@ def proxy_port
15091514
end
15101515
end
15111516

1512-
# The username of the proxy server, if one is configured.
1517+
# Returns the user name of the proxy server, if defined, +nil+ otherwise;
1518+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
15131519
def proxy_user
15141520
if @proxy_from_env
15151521
user = proxy_uri&.user
@@ -1519,7 +1525,8 @@ def proxy_user
15191525
end
15201526
end
15211527

1522-
# The password of the proxy server, if one is configured.
1528+
# Returns the password of the proxy server, if defined, +nil+ otherwise;
1529+
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
15231530
def proxy_pass
15241531
if @proxy_from_env
15251532
pass = proxy_uri&.password

0 commit comments

Comments
 (0)