From ed358526dd494b3e5347b7371af2634f95d4c814 Mon Sep 17 00:00:00 2001 From: Jeremy Evans Date: Thu, 26 Sep 2019 15:10:17 -0700 Subject: [PATCH] Update documentation for Kernel#BigDecimal() digits argument [ci skip] I expected this to affect the significant digits if providing the first argument as a String, but it does not. I'm positive this argument is ignored if the first argument is an Integer, but I'm not positive that it is ignored if the first argument is a String, as the value is passed to VpAlloc. However, if it has an effect, I'm not sure what it is. --- ext/bigdecimal/bigdecimal.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/ext/bigdecimal/bigdecimal.c b/ext/bigdecimal/bigdecimal.c index 648febf7..9c4c146d 100644 --- a/ext/bigdecimal/bigdecimal.c +++ b/ext/bigdecimal/bigdecimal.c @@ -2681,9 +2681,8 @@ VpNewVarArg(int argc, VALUE *argv) * If it is a String, spaces are ignored and unrecognized characters * terminate the value. * - * digits:: The number of significant digits, as an Integer. If omitted or 0, - * the number of significant digits is determined from the initial - * value. + * digits:: The number of significant digits, as an Integer. This is required if + * +initial+ is a Float or Rational, and ignored otherwise. * * The actual number of significant digits used in computation is * usually larger than the specified number.