Skip to content

Commit 5e34e74

Browse files
st0012jeremyevans
authored andcommitted
Remove unnecessary alias links
Those alias methods have been marked as `:nodoc: obsolete` for a long time. Which means the `rdoc-ref` links to them will be broken. Unless we want to encourage users to use them again, we don't need to mention them in the documentation.
1 parent 6475fa6 commit 5e34e74

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

lib/net/http.rb

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -475,8 +475,7 @@ class HTTPHeaderSyntaxError < StandardError; end
475475
#
476476
# - {::start}[rdoc-ref:Net::HTTP.start]:
477477
# Begins a new session in a new \Net::HTTP object.
478-
# - {#started?}[rdoc-ref:Net::HTTP#started?]
479-
# (aliased as {#active?}[rdoc-ref:Net::HTTP#active?]):
478+
# - {#started?}[rdoc-ref:Net::HTTP#started?]:
480479
# Returns whether in a session.
481480
# - {#finish}[rdoc-ref:Net::HTTP#finish]:
482481
# Ends an active session.
@@ -556,18 +555,15 @@ class HTTPHeaderSyntaxError < StandardError; end
556555
# Sends a PUT request and returns a response object.
557556
# - {#request}[rdoc-ref:Net::HTTP#request]:
558557
# Sends a request and returns a response object.
559-
# - {#request_get}[rdoc-ref:Net::HTTP#request_get]
560-
# (aliased as {#get2}[rdoc-ref:Net::HTTP#get2]):
558+
# - {#request_get}[rdoc-ref:Net::HTTP#request_get]:
561559
# Sends a GET request and forms a response object;
562560
# if a block given, calls the block with the object,
563561
# otherwise returns the object.
564-
# - {#request_head}[rdoc-ref:Net::HTTP#request_head]
565-
# (aliased as {#head2}[rdoc-ref:Net::HTTP#head2]):
562+
# - {#request_head}[rdoc-ref:Net::HTTP#request_head]:
566563
# Sends a HEAD request and forms a response object;
567564
# if a block given, calls the block with the object,
568565
# otherwise returns the object.
569-
# - {#request_post}[rdoc-ref:Net::HTTP#request_post]
570-
# (aliased as {#post2}[rdoc-ref:Net::HTTP#post2]):
566+
# - {#request_post}[rdoc-ref:Net::HTTP#request_post]:
571567
# Sends a POST request and forms a response object;
572568
# if a block given, calls the block with the object,
573569
# otherwise returns the object.
@@ -605,8 +601,7 @@ class HTTPHeaderSyntaxError < StandardError; end
605601
# Returns whether +self+ is a proxy class.
606602
# - {#proxy?}[rdoc-ref:Net::HTTP#proxy?]:
607603
# Returns whether +self+ has a proxy.
608-
# - {#proxy_address}[rdoc-ref:Net::HTTP#proxy_address]
609-
# (aliased as {#proxyaddr}[rdoc-ref:Net::HTTP#proxyaddr]):
604+
# - {#proxy_address}[rdoc-ref:Net::HTTP#proxy_address]:
610605
# Returns the proxy address.
611606
# - {#proxy_from_env?}[rdoc-ref:Net::HTTP#proxy_from_env?]:
612607
# Returns whether the proxy is taken from an environment variable.
@@ -718,8 +713,7 @@ class HTTPHeaderSyntaxError < StandardError; end
718713
# === \HTTP Version
719714
#
720715
# - {::version_1_2?}[rdoc-ref:Net::HTTP.version_1_2?]
721-
# (aliased as {::is_version_1_2?}[rdoc-ref:Net::HTTP.is_version_1_2?]
722-
# and {::version_1_2}[rdoc-ref:Net::HTTP.version_1_2]):
716+
# (aliased as {::version_1_2}[rdoc-ref:Net::HTTP.version_1_2]):
723717
# Returns true; retained for compatibility.
724718
#
725719
# === Debugging

0 commit comments

Comments
 (0)