1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

Restore documentation for Object#hash [ci skip]

Object#hash documentation was removed (probably by accident) in
7b19e6f3fd.
This commit is contained in:
Jeremy Evans 2019-07-26 16:57:42 -07:00
parent bd32833382
commit 6279cf8b2b

View file

@ -205,6 +205,25 @@ rb_obj_equal(VALUE obj1, VALUE obj2)
return Qfalse; return Qfalse;
} }
/**
* call-seq:
* obj.hash -> integer
*
* Generates an Integer hash value for this object. This function must have the
* property that <code>a.eql?(b)</code> implies <code>a.hash == b.hash</code>.
*
* The hash value is used along with #eql? by the Hash class to determine if
* two objects reference the same hash key. Any hash value that exceeds the
* capacity of an Integer will be truncated before being used.
*
* The hash value for an object may not be identical across invocations or
* implementations of Ruby. If you need a stable identifier across Ruby
* invocations and implementations you will need to generate one with a custom
* method.
*--
* \private
*++
*/
VALUE rb_obj_hash(VALUE obj); VALUE rb_obj_hash(VALUE obj);
/** /**