Skip to content

Commit 80d64f4

Browse files
Merge pull request #2454 from FormidableLabs/docs/typos
Docs: fix typos and grammatical errors
2 parents 149f399 + 12d27ae commit 80d64f4

29 files changed

+51
-51
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ Note that Chromatic internally runs `npm run build-storybook` around which we ha
222222

223223
We use [changesets](https://github.com/changesets/changesets) to create package versions and publish them.
224224

225-
### Using changsets
225+
### Using changesets
226226

227227
Our official release path is to use automation to perform the actual publishing of our packages. The steps are to:
228228

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Projects using Victory should also depend on [React][]. Victory works with React
8383

8484
## Victory Native
8585

86-
Victory Native shares most of its code with Victory, and has a nearly identical API! To learn more, check out the [Victory Native package REAMDE](./packages/victory-native/README.md).
86+
Victory Native shares most of its code with Victory, and has a nearly identical API! To learn more, check out the [Victory Native package README](./packages/victory-native/README.md).
8787

8888
## Contributing
8989
Please see the [Contributing guide](CONTRIBUTING.md).

docs/src/content/common-props/common-props.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ scope:
1515

1616
Not every component uses all of these props. These are all common to things like `VictoryBar`, `VictoryScatter`, but other components like `VictoryStack` use only some of them.
1717

18-
The props explanations given here are general. Each component docs page should be considered as the the source of truth for a component's props, and any caveats will be listed there.
18+
The props explanations given here are general. Each component docs page should be considered as the source of truth for a component's props, and any caveats will be listed there.
1919

2020
## animate
2121

@@ -292,7 +292,7 @@ ReactDOM.render(<CustomStyledBarChart/>, mountNode);
292292

293293
`type: array[low, high] || { x: [low, high], y: [low, high] }`
294294

295-
The `domain` prop describes the range of data the component will include. This prop can be given as a array of the minimum and maximum expected values of the data or as an object that specifies separate arrays for x and y. If this prop is not provided, a domain will be calculated from data, or other available information.
295+
The `domain` prop describes the range of data the component will include. This prop can be given as an array of the minimum and maximum expected values of the data or as an object that specifies separate arrays for x and y. If this prop is not provided, a domain will be calculated from data, or other available information.
296296

297297
_note:_ The `x` value supplied to the `domain` prop refers to the _independent_ variable, and the `y` value refers to the _dependent_ variable. This may cause confusion in horizontal charts, as the independent variable will corresponds to the y axis.
298298

@@ -350,7 +350,7 @@ Identifying properties include:
350350

351351
- `childName`: the name of the component the event should be attached to. When events are specified in `VictorySharedEvents` or on a component that renders several Victory components as children (_i.e._ `VictoryChart`, `VictoryGroup`, `VictoryStack`), it is necessary to specify which child events should apply to. The given `childName` should match the `name` prop of a child component. This identifier can be given as a string, an array of strings, or as "all".
352352

353-
- `target`: the type of element the event should be attached to. Valid targets for most Victory components will be `"parent"`, `"data"`, and `"labels"`. Events with the "parent" target will be attached to to the top level svg. Events with `"data"` and `"labels"` targets will be attached to `dataComponent` and `labelComponent` elements respectively. Some components, like `VictoryAxis` use non-standard targets like `"grid"`. Refer to individual API docs for additional caveats.
353+
- `target`: the type of element the event should be attached to. Valid targets for most Victory components will be `"parent"`, `"data"`, and `"labels"`. Events with the "parent" target will be attached to the top level svg. Events with `"data"` and `"labels"` targets will be attached to `dataComponent` and `labelComponent` elements respectively. Some components, like `VictoryAxis` use non-standard targets like `"grid"`. Refer to individual API docs for additional caveats.
354354

355355
- `eventKey`: the specific element to be targeted. Events may be attached to specific elements by `eventKey`. By default, `eventKey` corresponds to the index in the `data` array (or `tickValues` array) corresponding to a rendered element. This value may be given as a single string or number, an array of strings or numbers, or as "all". It is not typically necessary to specify an individual `eventKey` for attaching events. When no `eventKey` is given, events will be attached to all elements that match a given `childName` and `target`. Some components like `VictoryArea` and `VictoryLine` render only a single element for an entire series of data. For these, the `eventKey` should be "all".
356356

@@ -880,7 +880,7 @@ _default:_ `sortOrder="ascending"`
880880

881881
`type: boolean`
882882

883-
The `standalone` props specifies whether the component should be rendered in a independent `<svg>` element or in a `<g>` tag. This prop defaults to true, and renders an `svg`, however, wrapper components like `VictoryChart`, `VictoryStack`, and `VictoryGroup` force children to use `standalone={false}`.
883+
The `standalone` props specifies whether the component should be rendered in an independent `<svg>` element or in a `<g>` tag. This prop defaults to true, and renders an `svg`, however, wrapper components like `VictoryChart`, `VictoryStack`, and `VictoryGroup` force children to use `standalone={false}`.
884884

885885
_default:_ `standalone={true}`
886886

@@ -923,7 +923,7 @@ _note_ The `style` prop used by `VictoryAxis` has a different format than the st
923923

924924
_note_ When a component is rendered as a child of another Victory component, or within a custom `<svg>` element with `standalone={false}` parent styles will be applied to the enclosing `<g>` tag. Many styles that can be applied to a parent `<svg>` will not be expressed when applied to a `<g>`.
925925

926-
_note_ custom `angle` and `verticalAnchor` properties maybe included in labels styles.
926+
_note_ custom `angle` and `verticalAnchor` properties may be included in labels styles.
927927

928928
_default (provided by default theme):_ See [grayscale theme][] for more detail
929929

docs/src/content/docs/victory-area.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ _default:_ `standalone={true}`
439439

440440
`VictoryArea` uses the standard `style` prop. [Read about it here](/docs/common-props#style)
441441

442-
*note:* Since `VictoryArea` renders a single element to represent an entire dataset, it is not possible to use functional styles to change the style of the line as a function of individual `datum`. Instead, try using [gradient fills](/docs/faq/#how-can-i-use-gradient-fills-in-victory) for styling continuous data.
442+
*note:* Since `VictoryArea` renders a single element to represent an entire dataset, it is not possible to use functional styles to change the style of the line as a function of an individual `datum`. Instead, try using [gradient fills](/docs/faq/#how-can-i-use-gradient-fills-in-victory) for styling continuous data.
443443

444444
_default (provided by default theme):_ See [grayscale theme][] for more detail
445445

docs/src/content/docs/victory-axis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ axisLabelComponent={<VictoryLabel dy={20}/>}
7272

7373
## axisValue
7474

75-
The `axisValue` prop may be used to position the dependent axis. Ths prop is useful when dependent axes should line up with values on the independent axis.
75+
The `axisValue` prop may be used to position the dependent axis. This prop is useful when dependent axes should line up with values on the independent axis.
7676

7777
```playground
7878
<VictoryChart>

docs/src/content/docs/victory-boxplot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ data={[
113113
```
114114

115115
- As an array of data objects with pre-calculated summary statistics(`min`, `median`, `max`, `q1`, `q3`)
116-
When given in this format, `VictoryBoxPlot` _will not_ preform statistical analysis. Pre-calculating summary statistics for large datasets will improve performance.
116+
When given in this format, `VictoryBoxPlot` _will not_ perform statistical analysis. Pre-calculating summary statistics for large datasets will improve performance.
117117

118118
```jsx
119119
data={[

docs/src/content/docs/victory-brush-container.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ _default:_ `brushComponent={<rect/>}`
119119

120120
`type: "x" || "y"`
121121

122-
When the `brushDimension` prop is set, brushing will only be specific to the to the given dimension
122+
When the `brushDimension` prop is set, brushing will only be specific to the given dimension
123123
(either "x" or "y"), and the entire domain of the other dimension will be highlighted. When this prop
124124
is not specified, highlighting will occur along both dimensions.
125125

@@ -206,23 +206,23 @@ _default:_ `handleWidth={8}`
206206

207207
`type: function`
208208

209-
The optional `onBrushCleared` prop accepts an function to be called when tha active brush area is cleared. The function accepts the parameters of `domain` (the updated domain), and `props` (the props used by `VictoryBrushContainer`).
209+
The optional `onBrushCleared` prop accepts a function to be called when the active brush area is cleared. The function accepts the parameters of `domain` (the updated domain), and `props` (the props used by `VictoryBrushContainer`).
210210

211211
_example:_ `onBrushCleared={(domain, props) => handleBrushCleared(domain, props)}`
212212

213213
## onBrushDomainChange
214214

215215
`type: function`
216216

217-
The optional `onBrushDomainChange` prop accepts an function to be called on each update to the highlighted domain. The function accepts the parameters of `domain` (the updated domain), and `props` (the props used by `VictoryBrushContainer`).
217+
The optional `onBrushDomainChange` prop accepts a function to be called on each update to the highlighted domain. The function accepts the parameters of `domain` (the updated domain), and `props` (the props used by `VictoryBrushContainer`).
218218

219219
_example:_ `onBrushDomainChange={(domain, props) => handleDomainChange(domain, props)}`
220220

221221
## onBrushDomainChangeEnd
222222

223223
`type: function`
224224

225-
The optional `onBrushDomainChangeEnd` prop accepts an function to be called only on mouse up events. The function accepts the parameters of `domain` (the updated domain), and `props` (the props used by `VictoryBrushContainer`).
225+
The optional `onBrushDomainChangeEnd` prop accepts a function to be called only on mouse up events. The function accepts the parameters of `domain` (the updated domain), and `props` (the props used by `VictoryBrushContainer`).
226226

227227
_example:_ `onBrushDomainChangeEnd={(domain, props) => handleDomainChangeEnd(domain, props)}`
228228

docs/src/content/docs/victory-brush-line.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ The `brushAreaWidth` prop is used to specify the width of the interactive brush
7979

8080
`type: element`
8181

82-
The `brushComponent` prop specifies the component to be rendered for active brush.
82+
The `brushComponent` prop specifies the component to be rendered for the active brush.
8383
This component will be supplied with the following props: x, y, width, height, and style.
8484
When this prop is not specified, a [`Box`][] component will be rendered.
8585

docs/src/content/docs/victory-candlestick.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -543,15 +543,15 @@ Use `open` data accessor prop to define the open value of a candle.
543543

544544
_examples:_ `open="opening_value"`
545545

546-
**function:** use a function to translate each element in a data array into a open value
546+
**function:** use a function to translate each element in a data array into an open value
547547

548548
_examples:_ `open={() => 10}`
549549

550-
**array index:** specify which index of an array should be used as a open value when data is given as an array of arrays
550+
**array index:** specify which index of an array should be used as an open value when data is given as an array of arrays
551551

552552
_examples:_ `open={1}`
553553

554-
**path string or path array:** specify which property in an array of nested data objects should be used as a open value
554+
**path string or path array:** specify which property in an array of nested data objects should be used as an open value
555555

556556
_examples:_ `open="bonds.open"`, `open={["bonds", "open"]}`
557557

docs/src/content/docs/victory-chart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ animate={{
4949

5050
`type: element`
5151

52-
The `backgroundComponent` prop takes a component instance which will be responsible for rendering a background if the `VictoryChart`'s `style` component includes `background` styles. The new element created from the passed `backgroundComponent` will be provided with the following properties calculated by `VictoryChart`: `height`, `polar`, `scale`, `style`, `x`, `y`, `width`. All of these props on `Background` should take prececence over what `VictoryChart` is trying to set.
52+
The `backgroundComponent` prop takes a component instance which will be responsible for rendering a background if the `VictoryChart`'s `style` component includes `background` styles. The new element created from the passed `backgroundComponent` will be provided with the following properties calculated by `VictoryChart`: `height`, `polar`, `scale`, `style`, `x`, `y`, `width`. All of these props on `Background` should take precedence over what `VictoryChart` is trying to set.
5353

5454
_default:_ `<Background/>`
5555

0 commit comments

Comments
 (0)