From cd428b490d635726e3d39ae8aa896bc41708cbc4 Mon Sep 17 00:00:00 2001 From: Alan Wu Date: Tue, 16 Jul 2024 18:03:35 -0400 Subject: [DOC] No more is rb_ary_freeze() an alias of rb_obj_freeze() [Feature #20589] --- include/ruby/internal/intern/array.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'include/ruby/internal/intern/array.h') diff --git a/include/ruby/internal/intern/array.h b/include/ruby/internal/intern/array.h index 1909fdf17b..b2cc6b132d 100644 --- a/include/ruby/internal/intern/array.h +++ b/include/ruby/internal/intern/array.h @@ -144,7 +144,13 @@ void rb_ary_free(VALUE ary); */ void rb_ary_modify(VALUE ary); -/** @alias{rb_obj_freeze} */ +/** + * Freeze an array, preventing further modifications. The underlying buffer may + * be shrunk before freezing to conserve memory. + * + * @param[out] obj Object assumed to be an array to freeze. + * @see RB_OBJ_FREEZE() + */ VALUE rb_ary_freeze(VALUE obj); RBIMPL_ATTR_PURE() -- cgit v1.2.3