* object.c (rb_obj_hash): Added note that the hash value is not

  deterministic on Marc-Andre's suggestion.  Expanded description of
  the purpose of the hash method.  [Bug #6068]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@34769 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 11 insertions, 8 deletions

diff --git a/object.c b/object.c
index a981319e37..697e569d41 100644
--- a/object.c
+++ b/object.c
@@ -101,14 +101,17 @@ rb_obj_equal(VALUE obj1, VALUE obj2)
 }
 
 /*
- * Generates a <code>Fixnum</code> hash value for this object.
- * This function must have the property that a.eql?(b) implies
- * a.hash <code>==</code> b.hash.
- * The hash value is used by class <code>Hash</code>.
- * Any hash value that exceeds the capacity of a <code>Fixnum</code> will be
- * truncated before being used.
- *
- *      "waffle".hash #=> -910576647
+ * Generates a Fixnum 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 a Fixnum 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.
  */
 VALUE
 rb_obj_hash(VALUE obj)