From 308595739c32609ac5b167ecdc6cb6cb4ec6c81f Mon Sep 17 00:00:00 2001
From: Sebastian Martinez <sebastian@wyeworks.com>
Date: Mon, 15 Aug 2011 20:20:28 -0300
Subject: Document Hash#extract!.

---
 .../guides/source/active_support_core_extensions.textile     | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'railties/guides/source')

diff --git a/railties/guides/source/active_support_core_extensions.textile b/railties/guides/source/active_support_core_extensions.textile
index 781d3d08cd..a672b17e4a 100644
--- a/railties/guides/source/active_support_core_extensions.textile
+++ b/railties/guides/source/active_support_core_extensions.textile
@@ -2696,6 +2696,18 @@ hash                   # => {:a => 1}
 
 NOTE: Defined in +active_support/core_ext/hash/slice.rb+.
 
+h4. Extracting
+
+The method +extract!+ removes and returns the key/value pairs matching the given keys.
+
+<ruby>
+hash = {:a => 1, :b => 2}
+rest = hash.extract!(:a) # => {:a => 1}
+hash                     # => {:b => 2}
+</ruby>
+
+NOTE: Defined in +active_support/core_ext/hash/slice.rb+.
+
 h4. Indifferent Access
 
 The method +with_indifferent_access+ returns an +ActiveSupport::HashWithIndifferentAccess+ out of its receiver:
-- 
cgit v1.2.3