From 76c4811484f88ad43e95c36936688d3b7381abd7 Mon Sep 17 00:00:00 2001 From: Jos de Jong Date: Wed, 1 Nov 2023 12:36:15 +0100 Subject: [PATCH] fix: #3088 error in the description of the return type of `pickRandom` --- src/function/probability/pickRandom.js | 4 ++-- types/index.d.ts | 5 ++--- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/src/function/probability/pickRandom.js b/src/function/probability/pickRandom.js index bfc31fb492..3897ed72fc 100644 --- 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 index 9e10de1e20..aa99ae8fad 100644 --- 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(array: T[]): T pickRandom(array: T[], number: number): T[]