[DOC] No more is rb_ary_freeze() an alias of rb_obj_freeze()

[Feature #20589]
This commit is contained in:
Alan Wu 2024-07-16 18:03:35 -04:00
parent 403f44ec2c
commit cd428b490d
Notes: git 2024-07-17 14:25:39 +00:00

View File

@ -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()