From f85f969e8defdf26ed885ec8154a820a5c9af022 Mon Sep 17 00:00:00 2001 From: Greg Hurrell Date: Fri, 2 Jun 2017 00:00:34 -0700 Subject: [PATCH] Add some clarifying comments --- src/addDigits.js | 4 ++++ src/convert.js | 3 ++- src/multiplyDigits.js | 5 ++++- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/addDigits.js b/src/addDigits.js index 1d3b1a8..70b713c 100644 --- a/src/addDigits.js +++ b/src/addDigits.js @@ -5,6 +5,10 @@ * @flow */ +/** + * Adds two arrays of decimal digits, `aDigits` and `bDigits`, returning a new + * array of decimal digits in base `base`. + */ export default function addDigits( aDigits: Array, bDigits: Array, diff --git a/src/convert.js b/src/convert.js index a7f80ae..6b46caa 100644 --- a/src/convert.js +++ b/src/convert.js @@ -11,7 +11,8 @@ import joinDigits from './joinDigits'; import multiplyDigits from './multiplyDigits'; /** - * Convert `number` in base `inBase`, to base `outBase`. + * Convert `number` in base `inBase`, to base `outBase`. Both the input `number` + * and return value are string representations. */ export default function convert( number: string, diff --git a/src/multiplyDigits.js b/src/multiplyDigits.js index 8925689..011b8e2 100644 --- a/src/multiplyDigits.js +++ b/src/multiplyDigits.js @@ -8,7 +8,10 @@ import addDigits from './addDigits'; /** - * Multiplication is repeated addition. + * Multiply an array of decimal digits, `multiplicand`, by `number`, returning + * the result as an array of decimal digits in base `base`. + * + * Note that multiplication is implemented as repeated addition. */ export default function multiplyDigits( multiplicand: Array, -- 2.37.1