Skip to content

Commit 83865fb

Browse files
[docs] Typo fixes (#16835)
1 parent c8a1fdb commit 83865fb

File tree

12 files changed

+24
-24
lines changed

12 files changed

+24
-24
lines changed

docs/data/charts/radar/radar.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Not all the feature are implemented and its API might change in the future if ne
1616

1717
## Basics
1818

19-
A radar chart is defined by two main props.
19+
A radar chart is defined by two main props:
2020

2121
- The `series` prop which provides the values to display thanks to the `data` property.
2222
- The `radar` prop which defines the radar axes.
@@ -37,17 +37,17 @@ This item can either be:
3737
- A string used as the axis label. The other properties are populated from the data.
3838
- An object with the following properties:
3939
- `name`: The label associated to the axis.
40-
- `min`: The minimal value along this direction (by default 0).
41-
- `max`: The maximal value along this direction (by default the maximal value along this direction).
40+
- `min`: The minimum value along this direction (by default 0).
41+
- `max`: The maximum value along this direction (by default the maximum value along this direction).
4242

4343
{{"demo": "RadarAxis.js" }}
4444

4545
## Grid
4646

47-
The radar chart displays a grid behind the series that can be configured with
47+
The radar chart displays a grid behind the series that can be configured with:
4848

49-
- `startAngle` The rotation angle of the entire chart in degree
50-
- `divisions` The number of division of the grid
49+
- `startAngle` The rotation angle of the entire chart in degrees
50+
- `divisions` The number of divisions of the grid
5151

5252
{{"demo": "DemoRadar.js" }}
5353

@@ -70,6 +70,6 @@ If you miss some element or explanation, please open an issue describing what yo
7070

7171
In this example, we uses `RadarSeriesArea` and `RadarSeriesMarks` to modify the order of the elements:
7272
all the marks are on top of all the path.
73-
And we apply different properties based on the series id.
73+
Additionaly, we apply different properties based on the series id.
7474

7575
{{"demo": "CompositionExample.js" }}

docs/translations/api-docs/charts/axis-config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"disableLine": { "description": "If true, the axis line is disabled." },
1515
"disableTicks": { "description": "If true, the ticks are disabled." },
1616
"domainLimit": {
17-
"description": "Defines the axis scale domain based on the min/max values of series linked to it.<br />- &#39;nice&#39;: Rounds the domain at human friendly values.<br />- &#39;strict&#39;: Set the domain to the min/max value provided. No extras space is added.<br />- function: Receives the calculated extremums as parameters, and should return the axis domain."
17+
"description": "Defines the axis scale domain based on the min/max values of series linked to it.<br />- &#39;nice&#39;: Rounds the domain at human friendly values.<br />- &#39;strict&#39;: Set the domain to the min/max value provided. No extra space is added.<br />- function: Receives the calculated extremums as parameters, and should return the axis domain."
1818
},
1919
"fill": { "description": "The fill color of the axis text." },
2020
"height": { "description": "The height of the axis." },

docs/translations/api-docs/charts/radar-series-area/radar-series-area.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"componentDescription": "",
33
"propDescriptions": {
44
"seriesId": {
5-
"description": "The id of the series To display. If undefined all series are display."
5+
"description": "The id of the series to display. If undefined all series are displayed."
66
}
77
},
88
"classDescriptions": {}

docs/translations/api-docs/charts/radar-series-marks/radar-series-marks.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"componentDescription": "",
33
"propDescriptions": {
44
"seriesId": {
5-
"description": "The id of the series To display. If undefined all series are display."
5+
"description": "The id of the series to display. If undefined all series are displayed."
66
}
77
},
88
"classDescriptions": {}

docs/translations/api-docs/charts/radar-series-plot/radar-series-plot.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"componentDescription": "",
33
"propDescriptions": {
44
"seriesId": {
5-
"description": "The id of the series To display. If undefined all series are display."
5+
"description": "The id of the series to display. If undefined all series are displayed."
66
}
77
},
88
"classDescriptions": {}

packages/x-charts/src/RadarChart/RadarDataProvider/radar.types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export interface MetricConfig {
99
*/
1010
min?: number;
1111
/**
12-
* The maximal value of the domain.
12+
* The maximum value of the domain.
1313
* If not provided, it gets computed to display the entire chart data.
1414
*/
1515
max?: number;
@@ -22,7 +22,7 @@ export interface RadarConfig {
2222
metrics: string[] | MetricConfig[];
2323
/**
2424
* The default max value for radius axes.
25-
* It will be override if `metrics` contains a `max` property.
25+
* It will be overridden if `metrics` contains a `max` property.
2626
*/
2727
max?: number;
2828
/**

packages/x-charts/src/RadarChart/RadarSeriesPlot/RadarSeriesArea.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ RadarSeriesArea.propTypes = {
3030
// | To update them edit the TypeScript types and run "pnpm proptypes" |
3131
// ----------------------------------------------------------------------
3232
/**
33-
* The id of the series To display.
34-
* If undefined all series are display.
33+
* The id of the series to display.
34+
* If undefined all series are displayed.
3535
*/
3636
seriesId: PropTypes.string,
3737
} as any;

packages/x-charts/src/RadarChart/RadarSeriesPlot/RadarSeriesMarks.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ RadarSeriesMarks.propTypes = {
3434
// | To update them edit the TypeScript types and run "pnpm proptypes" |
3535
// ----------------------------------------------------------------------
3636
/**
37-
* The id of the series To display.
38-
* If undefined all series are display.
37+
* The id of the series to display.
38+
* If undefined all series are displayed.
3939
*/
4040
seriesId: PropTypes.string,
4141
} as any;

packages/x-charts/src/RadarChart/RadarSeriesPlot/RadarSeriesPlot.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ RadarSeriesPlot.propTypes = {
3636
// | To update them edit the TypeScript types and run "pnpm proptypes" |
3737
// ----------------------------------------------------------------------
3838
/**
39-
* The id of the series To display.
40-
* If undefined all series are display.
39+
* The id of the series to display.
40+
* If undefined all series are displayed.
4141
*/
4242
seriesId: PropTypes.string,
4343
} as any;

packages/x-charts/src/RadarChart/RadarSeriesPlot/RadarSeriesPlot.types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ import * as React from 'react';
22

33
interface CommonRadarSeriesPlotProps {
44
/**
5-
* The id of the series To display.
6-
* If undefined all series are display.
5+
* The id of the series to display.
6+
* If undefined all series are displayed.
77
*/
88
seriesId?: string;
99
}

packages/x-charts/src/internals/plugins/featurePlugins/useChartPolarAxis/useChartPolarAxis.types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ export type PolarAxisState = {
2020
*/
2121
radiusAxis: DefaultizedAxisConfig<ChartsRadiusAxisProps>;
2222
/**
23-
* The rotation-axes IDs sorted by order they got provided.
23+
* The rotation-axes IDs sorted by order they were provided.
2424
*/
2525
rotationAxisIds: AxisId[];
2626
/**
27-
* The radius-axes IDs sorted by order they got provided.
27+
* The radius-axes IDs sorted by order they were provided.
2828
*/
2929
radiusAxisIds: AxisId[];
3030
};

packages/x-charts/src/models/axis.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ type CommonAxisConfig<S extends ScaleName = ScaleName, V = any> = {
383383
/**
384384
* Defines the axis scale domain based on the min/max values of series linked to it.
385385
* - 'nice': Rounds the domain at human friendly values.
386-
* - 'strict': Set the domain to the min/max value provided. No extras space is added.
386+
* - 'strict': Set the domain to the min/max value provided. No extra space is added.
387387
* - function: Receives the calculated extremums as parameters, and should return the axis domain.
388388
*/
389389
domainLimit?: 'nice' | 'strict' | ((min: number, max: number) => { min: number; max: number });

0 commit comments

Comments
 (0)