docs: update field comments

airbnb · Aug 4, 2020 · 32a2dec · 32a2dec
1 parent dfbd466
commit 32a2dec
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/packages/vx-grid/src/grids/GridColumns.tsx b/packages/vx-grid/src/grids/GridColumns.tsx
@@ -7,9 +7,12 @@ import { getTicks, ScaleInput } from '@vx/scale';
 import { CommonGridProps, GridScale } from '../types';
 
 export type GridColumnProps<Scale extends GridScale> = CommonGridProps & {
-  /** `@vx/scale` or `d3-scale` object used to map from ScaleInput to x-coordinates. */
+  /** `@vx/scale` or `d3-scale` object used to convert value to position. */
   scale: Scale;
-  /** Exact values used to generate grid coordinates (y- for Rows, x- for Columns) lines using `scale`. Overrides `numTicks` if specified. */
+  /**
+   * Exact values used to generate grid coordinates lines using `scale`.
+   * Overrides `numTicks` if specified.
+   */
   tickValues?: ScaleInput<Scale>[];
   /** Total height of the each grid column line. */
   height: number;

diff --git a/packages/vx-grid/src/grids/GridRows.tsx b/packages/vx-grid/src/grids/GridRows.tsx
@@ -7,9 +7,12 @@ import { getTicks, ScaleInput } from '@vx/scale';
 import { CommonGridProps, GridScale } from '../types';
 
 export type GridRowsProps<Scale extends GridScale> = CommonGridProps & {
-  /** `@vx/scale` or `d3-scale` object used to map from ScaleInput to y-coordinates. */
+  /** `@vx/scale` or `d3-scale` object used to convert value to position. */
   scale: Scale;
-  /** Exact values used to generate grid coordinates (y- for Rows, x- for Columns) lines using `scale`. Overrides `numTicks` if specified. */
+  /**
+   * Exact values used to generate grid coordinates lines using `scale`.
+   * Overrides `numTicks` if specified.
+   */
   tickValues?: ScaleInput<Scale>[];
   /** Total width of the each grid row line. */
   width: number;