summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2025-12-29 18:41:58 +0900
committerNobuyoshi Nakada <nobu@ruby-lang.org>2025-12-29 18:41:58 +0900
commit26088dcd4a1f1784ae24387ce6a98fcad48749c5 (patch)
treeb4da4d2ebced8256bb7ac99991954290f5b9f2a8 /include
parent56a6a21f28bd2b47bc96c58ae276b272933e7f62 (diff)
[DOC] State that `rb_unexpected_type` is private
Diffstat (limited to 'include')
-rw-r--r--include/ruby/internal/error.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/include/ruby/internal/error.h b/include/ruby/internal/error.h
index 3ff885b2b1..5bf82bfe7d 100644
--- a/include/ruby/internal/error.h
+++ b/include/ruby/internal/error.h
@@ -421,11 +421,12 @@ void rb_readwrite_syserr_fail(enum rb_io_wait_readwrite waiting, int err, const
RBIMPL_ATTR_COLD()
RBIMPL_ATTR_NORETURN()
/**
+ * @private
+ *
* Fails with the given object's type incompatibility to the type.
*
- * It seems this function is visible from extension libraries only because
- * RTYPEDDATA_TYPE() uses it on RUBY_DEBUG. So you can basically ignore it;
- * use some other fine-grained method instead.
+ * This is an implementation detail of Check_Type. People don't use it
+ * directly.
*
* @param[in] self The object in question.
* @param[in] t Expected type of the object.