From 344c16eba40457f937c6558299f52bc97d6f3ce7 Mon Sep 17 00:00:00 2001
From: Takashi Kokubun <takashikkbn@gmail.com>
Date: Mon, 30 Jan 2023 13:14:18 -0800
Subject: Avoid using a weird syntax for documentation

Following up 465bd972ec2.

If the actual implementation still resides in C, it should be
documented in C just like all other places.
---
 numeric.c | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'numeric.c')

diff --git a/numeric.c b/numeric.c
index 15729e4728..d1316eb6e2 100644
--- a/numeric.c
+++ b/numeric.c
@@ -6008,7 +6008,22 @@ rb_int_s_isqrt(VALUE self, VALUE num)
     }
 }
 
-/* :nodoc: */
+/*
+ * call-seq:
+ *   Integer.try_convert(object) -> object, integer, or nil
+ *
+ * If +object+ is an \Integer object, returns +object+.
+ *   Integer.try_convert(1) # => 1
+ *
+ * Otherwise if +object+ responds to <tt>:to_int</tt>,
+ * calls <tt>object.to_int</tt> and returns the result.
+ *   Integer.try_convert(1.25) # => 1
+ *
+ * Returns +nil+ if +object+ does not respond to <tt>:to_int</tt>
+ *   Integer.try_convert([]) # => nil
+ *
+ * Raises an exception unless <tt>object.to_int</tt> returns an \Integer object.
+ */
 static VALUE
 int_s_try_convert(VALUE self, VALUE num)
 {
-- 
cgit v1.2.1