Skip to content

Commit 8886d2b

Browse files
committed
[DOC] Update docs for RB_OBJ_WB_UNPROTECT
1 parent 9e89e5f commit 8886d2b

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

  • include/ruby/internal

include/ruby/internal/gc.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -621,11 +621,11 @@ RBIMPL_SYMBOL_EXPORT_END()
621621
#define OBJ_WB_UNPROTECT RB_OBJ_WB_UNPROTECT /**< @old{RB_OBJ_WB_UNPROTECT} */
622622

623623
/**
624-
* Asserts that the passed object is not fenced by write barriers. Objects of
625-
* such property do not contribute to generational GCs. They are scanned
626-
* always.
624+
* Marks the object as not protected by write barriers. These objects do not
625+
* participate in generational GCs which means that, as long as the object is
626+
* alive, they will be scanned on every GC cycle.
627627
*
628-
* @param[out] x An object that would not be protected by the barrier.
628+
* @param[out] x An object that is not be protected by the write barrier.
629629
*/
630630
#define RB_OBJ_WB_UNPROTECT(x) rb_obj_wb_unprotect(x, __FILE__, __LINE__)
631631

0 commit comments

Comments
 (0)