diff options
| author | Alan Wu <[email protected]> | 2024-11-29 18:33:44 -0500 |
|---|---|---|
| committer | Alan Wu <[email protected]> | 2024-11-29 18:33:44 -0500 |
| commit | 2a0006c10102e544d18767f17eff3c8301c14959 (patch) | |
| tree | 0a1cabae7389eb75faae3124b252885c5a88d008 /include/ruby | |
| parent | 2fc357c16d2b10f5a9058063c78c308d34101921 (diff) | |
[DOC] Mention that rb_id2str() returns a frozen string
Diffstat (limited to 'include/ruby')
| -rw-r--r-- | include/ruby/internal/symbol.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/include/ruby/internal/symbol.h b/include/ruby/internal/symbol.h index 869a31115c..ac11a2c813 100644 --- 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. |