Skip to content

Commit e631911

Browse files
committed
* lib/net/imap.rb (initialize): fixed documentation.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@14468 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
1 parent c1bcdb3 commit e631911

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

lib/net/imap.rb

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -876,28 +876,24 @@ def self.encode_utf7(s)
876876
@@debug = false
877877
@@authenticators = {}
878878

879+
# call-seq:
880+
# Net::IMAP.new(host, options = {})
881+
#
879882
# Creates a new Net::IMAP object and connects it to the specified
880-
# port (143 by default) on the named +host+.
883+
# +host+.
881884
#
882-
# If +port_or_options+ responds to to_int, it is used as port number.
883-
# Otherwise +port_or_options+ is an option hash.
885+
# +options+ is an option hash.
884886
#
885887
# The available options are:
886888
#
887889
# :port:: port number (default value is 143 for imap, or 993 for imaps)
888-
# :ssl:: if port_or_options[:ssl] is true, then an attempt will be made
890+
# :ssl:: if +options[:ssl]+ is true, then an attempt will be made
889891
# to use SSL (now TLS) to connect to the server. For this to work
890892
# OpenSSL [OSSL] and the Ruby OpenSSL [RSSL] extensions need to
891893
# be installed.
892-
# if port_or_options[:ssl] is a hash, it's passed to
894+
# if +options[:ssl]+ is a hash, it's passed to
893895
# OpenSSL::SSL::SSLContext.build as parameters.
894896
#
895-
# +usessl+, +certs+, and +verify+ are for backward compatibility.
896-
# If +usessl+ is true, then an attempt will be made to use SSL (now TLS)
897-
# to connect to the server. The +certs+ parameter indicates
898-
# the path or file containing the CA cert of the server, and the
899-
# +verify+ parameter is for the OpenSSL verification callback.
900-
#
901897
# The most common errors are:
902898
#
903899
# Errno::ECONNREFUSED:: connection refused by +host+ or an intervening

0 commit comments

Comments
 (0)