Skip to content

Commit 61c35f7

Browse files
committed
📚 Update Config#responses_without_block rdoc
The planned `:future` config value is `:frozen_dup`, not `:raise`.
1 parent 69b240f commit 61c35f7

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

lib/net/imap/config.rb

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ class IMAP
7575
#
7676
# client = Net::IMAP.new(hostname, config: :future)
7777
# client.config.sasl_ir # => true
78-
# client.config.responses_without_block # => :raise
78+
# client.config.responses_without_block # => :frozen_dup
7979
#
8080
# The versioned default configs inherit certain specific config options from
8181
# Config.global, for example #debug:
@@ -109,9 +109,11 @@ class IMAP
109109
# [+:future+]
110110
# The _planned_ eventual config for some future +x.y+ version.
111111
#
112-
# For example, to raise exceptions for all current deprecations:
112+
# For example, to disable all currently deprecated behavior:
113113
# client = Net::IMAP.new(hostname, config: :future)
114-
# client.responses # raises an ArgumentError
114+
# client.config.response_without_args # => :frozen_dup
115+
# client.responses.frozen? # => true
116+
# client.responses.values.all?(&:frozen?) # => true
115117
#
116118
# == Thread Safety
117119
#

0 commit comments

Comments
 (0)