fix: #3088 error in the description of the return type of pickRandom

josdejong · Nov 1, 2023 · 76c4811 · 76c4811
1 parent f9ab3a1
commit 76c4811
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/src/function/probability/pickRandom.js b/src/function/probability/pickRandom.js
@@ -50,8 +50,8 @@ export const createPickRandom = /* #__PURE__ */ factory(name, dependencies, ({ t
    * @param {Array | Matrix} array     A one dimensional array
    * @param {Int} number               An int or float
    * @param {Array | Matrix} weights   An array of ints or floats
-   * @return {number | Array}          Returns a single random value from array when number is 1 or undefined.
-   *                                   Returns an array with the configured number of elements when number is > 1.
+   * @return {number | Array}          Returns a single random value from array when number is undefined.
+   *                                   Returns an array with the configured number of elements when number is defined.
    */
   return typed(name, {
     'Array | Matrix': function (possibles) {

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -2275,9 +2275,8 @@ export interface MathJsInstance extends MathJsFactory {
    * @param array A one dimensional array
    * @param number An int or float
    * @param weights An array of ints or floats
-   * @returns Returns a single random value from array when number is 1 or
-   * undefined. Returns an array with the configured number of elements
-   * when number is > 1.
+   * @returns Returns a single random value from array when number is undefined.
+   * Returns an array with the configured number of elements when number is defined.
    */
   pickRandom<T>(array: T[]): T
   pickRandom<T>(array: T[], number: number): T[]