docs: Fix table JSDoc comments.

uwdata · Jan 8, 2021 · f7f32d8 · f7f32d8
1 parent 3083ad3
commit f7f32d8
Showing 1 changed file with 5 additions and 1 deletion.
diff --git 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] })
  */