mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
update AS:OrderedHash docs
This commit is contained in:
parent
3004bc2470
commit
b1dfcc968b
1 changed files with 8 additions and 4 deletions
|
@ -5,16 +5,20 @@ YAML.add_builtin_type("omap") do |type, val|
|
|||
end
|
||||
|
||||
module ActiveSupport
|
||||
# The order of iteration over hashes in Ruby 1.8 is undefined. For example, you do not know the
|
||||
# order in which +keys+ will return keys, or +each+ yield pairs. <tt>ActiveSupport::OrderedHash</tt>
|
||||
# implements a hash that preserves insertion order, as in Ruby 1.9:
|
||||
# <tt>ActiveSupport::OrderedHash</tt> implements a hash that preserves
|
||||
# insertion order.
|
||||
#
|
||||
# oh = ActiveSupport::OrderedHash.new
|
||||
# oh[:a] = 1
|
||||
# oh[:b] = 2
|
||||
# oh.keys # => [:a, :b], this order is guaranteed
|
||||
#
|
||||
# <tt>ActiveSupport::OrderedHash</tt> is namespaced to prevent conflicts with other implementations.
|
||||
# Also, maps the +omap+ feature for YAML files
|
||||
# (See http://yaml.org/type/omap.html) to support ordered items
|
||||
# when loading from yaml.
|
||||
#
|
||||
# <tt>ActiveSupport::OrderedHash</tt> is namespaced to prevent conflicts
|
||||
# with other implementations.
|
||||
class OrderedHash < ::Hash
|
||||
def to_yaml_type
|
||||
"!tag:yaml.org,2002:omap"
|
||||
|
|
Loading…
Reference in a new issue