Skip to content

Commit

Permalink
📚 Update Config#responses_without_block rdoc
Browse files Browse the repository at this point in the history
The planned `:future` config value is `:frozen_dup`, not `:raise`.
  • Loading branch information
nevans committed Jan 4, 2025
1 parent 69b240f commit 61c35f7
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions lib/net/imap/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ class IMAP
#
# client = Net::IMAP.new(hostname, config: :future)
# client.config.sasl_ir # => true
# client.config.responses_without_block # => :raise
# client.config.responses_without_block # => :frozen_dup
#
# The versioned default configs inherit certain specific config options from
# Config.global, for example #debug:
Expand Down Expand Up @@ -109,9 +109,11 @@ class IMAP
# [+:future+]
# The _planned_ eventual config for some future +x.y+ version.
#
# For example, to raise exceptions for all current deprecations:
# For example, to disable all currently deprecated behavior:
# client = Net::IMAP.new(hostname, config: :future)
# client.responses # raises an ArgumentError
# client.config.response_without_args # => :frozen_dup
# client.responses.frozen? # => true
# client.responses.values.all?(&:frozen?) # => true
#
# == Thread Safety
#
Expand Down

0 comments on commit 61c35f7

Please sign in to comment.