[DOC] Document RbConfig::LIMITS

XrXr · Jul 14, 2024 · fac271a · fac271a
1 parent a97c2ce
commit fac271a
Showing 1 changed file with 14 additions and 0 deletions.
diff --git 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)
 {