From: Benoit Daloze <redmine@...>
Date: 2011-07-18T22:03:45+09:00
Subject: [ruby-core:38163] [Ruby 1.9 - Bug #5045][Open] wrong method in doc of Net::HTTP


Issue #5045 has been reported by Benoit Daloze.

----------------------------------------
Bug #5045: wrong method in doc of Net::HTTP
http://redmine.ruby-lang.org/issues/5045

Author: Benoit Daloze
Status: Open
Priority: Normal
Assignee: Eric Hodel
Category: DOC
Target version: 1.9.4
ruby -v: ruby 1.9.4dev (2011-07-16 trunk 32562) [x86_64-darwin10.7.0]


Hello,

I found a small typo in the documentation of Net::HTTP:

diff --git a/lib/net/http.rb b/lib/net/http.rb
index f898588..7c9032a 100644
--- a/lib/net/http.rb
+++ b/lib/net/http.rb
@@ -108,7 +108,7 @@ module Net   #:nodoc:
   # If you wish to re-use a connection across multiple HTTP requests without
   # automatically closing it you can use ::new instead of ::start.  #request
   # will automatically open a connection to the server if one is not currently
-  # open.  You can manually close the connection with #close.
+  # open.  You can manually close the connection with #finish.
   #
   # === Response Data
   #

There is no method #close, it is named #finish.

I find #close clearer, and #finish being the opposite of ::start is unfortunate (because ::start automatically close the connection at the end of the block, while #new not, as written upper).
Another way to solve this might be to alias #close to #finish, what do you think ?


-- 
http://redmine.ruby-lang.org