fix: improve a code comment

inclusive-design · Feb 1, 2024 · a1badc7 · a1badc7
1 parent 1f73831
commit a1badc7
Showing 1 changed file with 2 additions and 3 deletions.
diff --git a/src/Palette.ts b/src/Palette.ts
@@ -22,9 +22,8 @@ type PalettePropsType = {
  * Given a palette defined in a json structure, compute the number of rows
  * and columns in that palette.
  *
- * @param {Object} paletteDefinition - An object in the pre-defined type of
- *                 `JsonPaletteType` that lists the positions, heights and
- *                  widths of the cells in the palette.
+ * @param {JsonPaletteType} paletteDefinition - A JSON palette object that
+ * lists the positions, heights and widths of the cells in the palette.
  * @return {Object} - The row and column counts: `{ numRows: ..., numColumns: ...}`.
  */
 function countRowsColumns (paletteDefinition: JsonPaletteType) {