Merge pull request #20778 from maurogeorge/ordered_options_bang_doc

Add to RDoc of OrderedOptions the bang info [ci skip]

1 files changed, 8 insertions, 0 deletions

diff --git a/activesupport/lib/active_support/ordered_options.rb b/activesupport/lib/active_support/ordered_options.rb
index bc0326473d..45864990ce 100644
--- a/activesupport/lib/active_support/ordered_options.rb
+++ b/activesupport/lib/active_support/ordered_options.rb
@@ -6,6 +6,7 @@ module ActiveSupport
   #   h[:girl] = 'Mary'
   #   h[:boy]  # => 'John'
   #   h[:girl] # => 'Mary'
+  #   h[:dog]  # => nil
   #
   # Using +OrderedOptions+, the above code could be reduced to:
   #
@@ -14,6 +15,13 @@ module ActiveSupport
   #   h.girl = 'Mary'
   #   h.boy  # => 'John'
   #   h.girl # => 'Mary'
+  #   h.dog  # => nil
+  #
+  # To raise an exception when the value is blank, append a
+  # bang to the key name, like:
+  #
+  #   h.dog! # => raises KeyError
+  #
   class OrderedOptions < Hash
     alias_method :_get, :[] # preserve the original #[] method
     protected :_get # make it protected