[DOC] Tweaks to String::try_convert

This commit is contained in:
Burdette Lamar 2025-04-02 11:03:17 -05:00 committed by GitHub
parent ce1dfe81c2
commit 2a55cc3fb8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
Notes: git 2025-04-02 16:03:35 +00:00
Merged: https://github.com/ruby/ruby/pull/13030

Merged-By: peterzhu2118 <peter@peterzhu.ca>

View File

@ -2874,14 +2874,16 @@ rb_check_string_type(VALUE str)
* call-seq: * call-seq:
* String.try_convert(object) -> object, new_string, or nil * String.try_convert(object) -> object, new_string, or nil
* *
* If +object+ is a +String+ object, returns +object+. * Attempts to convert the given +object+ to a string.
*
* If +object+ is already a string, returns +object+, unmodified.
* *
* Otherwise if +object+ responds to <tt>:to_str</tt>, * Otherwise if +object+ responds to <tt>:to_str</tt>,
* calls <tt>object.to_str</tt> and returns the result. * calls <tt>object.to_str</tt> and returns the result.
* *
* Returns +nil+ if +object+ does not respond to <tt>:to_str</tt>. * Returns +nil+ if +object+ does not respond to <tt>:to_str</tt>.
* *
* Raises an exception unless <tt>object.to_str</tt> returns a +String+ object. * Raises an exception unless <tt>object.to_str</tt> returns a string.
*/ */
static VALUE static VALUE
rb_str_s_try_convert(VALUE dummy, VALUE str) rb_str_s_try_convert(VALUE dummy, VALUE str)