[DOC] Mention that rb_id2str() returns a frozen string

XrXr · XrXr · commit 2a0006c10102 · 2024-11-29T18:33:44.000-05:00
diff --git a/include/ruby/internal/symbol.h b/include/ruby/internal/symbol.h
@@ -186,7 +186,8 @@ ID rb_check_id(volatile VALUE *namep);
 ID rb_to_id(VALUE str);
 
 /**
- * Identical to rb_id2name(), except it returns a Ruby's String instead of C's.
+ * Identical to rb_id2name(), except it returns a frozen Ruby String instead of
+ * a C String.
  *
  * @param[in]  id           An id to query.
  * @retval     RUBY_Qfalse  No such id ever existed in the history.

Original file line number	Diff line number	Diff line change
`@@ -186,7 +186,8 @@ ID rb_check_id(volatile VALUE *namep);`
`186`	`186`	`ID rb_to_id(VALUE str);`
`187`	`187`
`188`	`188`	`/**`
`189`		`- * Identical to rb_id2name(), except it returns a Ruby's String instead of C's.`
	`189`	`+ * Identical to rb_id2name(), except it returns a frozen Ruby String instead of`
	`190`	`+ * a C String.`
`190`	`191`	`*`
`191`	`192`	`* @param[in] id An id to query.`
`192`	`193`	`* @retval RUBY_Qfalse No such id ever existed in the history.`