summaryrefslogtreecommitdiff
path: root/random.c
diff options
context:
space:
mode:
authorNobuyoshi Nakada <nobu@ruby-lang.org>2021-12-13 19:54:38 +0900
committerNobuyoshi Nakada <nobu@ruby-lang.org>2021-12-13 19:55:44 +0900
commitdc490aced3fc62d7eaa10d2bfc2211da826ea538 (patch)
tree8218a3eb01f1774e83e884f7c05834a7e97b58d1 /random.c
parent6859d175ba5c77f0aab0af20e2b483c8d5ea9126 (diff)
downloadruby-dc490aced3fc62d7eaa10d2bfc2211da826ea538.tar.gz
[DOC] Improve Random::Formatter description and example
Diffstat (limited to 'random.c')
-rw-r--r--random.c9
1 files changed, 8 insertions, 1 deletions
diff --git a/random.c b/random.c
index 580c1f26eb..32c470bdad 100644
--- a/random.c
+++ b/random.c
@@ -1807,7 +1807,14 @@ InitVM_Random(void)
rb_define_private_method(CLASS_OF(rb_cRandom), "left", random_s_left, 0);
{
- /* Format raw random number as Random does */
+ /*
+ * Generate a random number in the given range as Random does
+ *
+ * prng.random_number #=> 0.5816771641321361
+ * prng.random_number(1000) #=> 485
+ * prng.rand #=> 0.5816771641321361
+ * prng.rand(1000) #=> 485
+ */
VALUE m = rb_define_module_under(rb_cRandom, "Formatter");
rb_include_module(base, m);
rb_extend_object(base, m);