summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--template/limits.c.tmpl14
1 files changed, 14 insertions, 0 deletions
diff --git a/template/limits.c.tmpl b/template/limits.c.tmpl
index c3c2a47624..d1e5b44592 100644
--- a/template/limits.c.tmpl
+++ b/template/limits.c.tmpl
@@ -51,6 +51,20 @@
# include <float.h>
#endif
+/*
+ * Document-const: LIMITS
+ *
+ * A Hash with the bounds of numeric types available to the \C compiler
+ * used to build Ruby. To access this constant, first run
+ * <code>require 'rbconfig/sizeof'</code>.
+ *
+ * require 'rbconfig/sizeof'
+ * RUBY_PLATFORM # => "x64-mingw-ucrt"
+ * RbConfig::LIMITS.fetch_values('FIXNUM_MAX', 'LONG_MAX')
+ * # => [1073741823, 2147483647]
+ *
+ */
+
void
Init_limits(void)
{