summaryrefslogtreecommitdiff
path: root/array.c
diff options
context:
space:
mode:
authorBurdetteLamar <[email protected]>2024-09-26 14:40:28 -0500
committerPeter Zhu <[email protected]>2024-09-28 20:59:36 -0400
commitd64528c69564989a9a72e398ba05a4c2a2eefff1 (patch)
tree12bf52984c2a9e1436ead0aa1e8698e33fb87c40 /array.c
parent5a7b66fa97d0a7eee4c9a2e9ce8196f91539986f (diff)
[DOC] Tweaks for Array#freeze
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/11703
Diffstat (limited to 'array.c')
-rw-r--r--array.c9
1 files changed, 6 insertions, 3 deletions
diff --git a/array.c b/array.c
index c94d2cb197..276646fc0d 100644
--- a/array.c
+++ b/array.c
@@ -629,16 +629,19 @@ ary_ensure_room_for_push(VALUE ary, long add_len)
/*
* call-seq:
- * array.freeze -> self
+ * freeze -> self
*
- * Freezes +self+; returns +self+:
+ * Freezes +self+ (if not already frozen); returns +self+:
*
* a = []
* a.frozen? # => false
* a.freeze
* a.frozen? # => true
*
- * An attempt to modify a frozen +Array+ raises FrozenError.
+ * No further changes may be made to +self+;
+ * raises FrozenError if a change is attempted.
+ *
+ * Related: Kernel#frozen?.
*/
VALUE