From f7f32d84ee1191de7c2dc19f358f727f202200f1 Mon Sep 17 00:00:00 2001 From: jheer Date: Fri, 8 Jan 2021 16:40:42 +0100 Subject: [PATCH] docs: Fix table JSDoc comments. --- src/verbs/index.js | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/verbs/index.js b/src/verbs/index.js index 1832aa3a..c3338ac0 100644 --- a/src/verbs/index.js +++ b/src/verbs/index.js @@ -86,8 +86,12 @@ export { * @param {object} columns * The set of named column arrays. * Object keys are the column names. - * The enumeration order of the keys determines the column indices. + * The enumeration order of the keys determines the column indices, + * unless the names parameter is specified. * Object values must be arrays (or array-like values) of identical length. + * @param {string[]} [names] Ordered list of column names. If specified, + * this array determines the column indices. If not specified, the + * key enumeration order of the columns object is used. * @return {ColumnTable} the instantiated table * @example table({ colA: ['a', 'b', 'c'], colB: [3, 4, 5] }) */