Skip to content

Commit 72e4eb7

Browse files
committed
📚 Update rdoc for methods delegated to Config
1 parent 0edda3c commit 72e4eb7

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

lib/net/imap.rb

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -807,9 +807,11 @@ class IMAP < Protocol
807807
def self.config; Config.global end
808808

809809
# Returns the global debug mode.
810+
# Delegates to {Net::IMAP.config.debug}[rdoc-ref:Config#debug].
810811
def self.debug; config.debug end
811812

812813
# Sets the global debug mode.
814+
# Delegates to {Net::IMAP.config.debug=}[rdoc-ref:Config#debug=].
813815
def self.debug=(val)
814816
config.debug = val
815817
end
@@ -839,13 +841,20 @@ class << self
839841
# Net::IMAP.config.
840842
attr_reader :config
841843

844+
##
845+
# :attr_reader: open_timeout
842846
# Seconds to wait until a connection is opened.
843-
# If the IMAP object cannot open a connection within this time,
844-
# it raises a Net::OpenTimeout exception. The default value is 30 seconds.
845-
def open_timeout; config.open_timeout end
847+
# Delegates to {config.open_timeout}[rdoc-ref:Config#open_timeout].
846848

849+
##
850+
# :attr_reader: idle_response_timeout
847851
# Seconds to wait until an IDLE response is received.
848-
def idle_response_timeout; config.idle_response_timeout end
852+
# Delegates to {config.idle_response_timeout}[rdoc-ref:Config#idle_response_timeout].
853+
854+
# :stopdoc:
855+
def open_timeout; config.open_timeout end
856+
def idle_response_timeout; config.idle_response_timeout end
857+
# :startdoc:
849858

850859
# The hostname this client connected to
851860
attr_reader :host

0 commit comments

Comments
 (0)