Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix typos and broken links in the documents #5010

Merged
merged 2 commits into from Nov 30, 2017
Merged

fix typos and broken links in the documents #5010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7aca90d
fix typos and broken links in the documents
Nov 29, 2017
a51b628
Change the "Ratio" section to "Pixel Ratio"
Nov 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/SUMMARY.md
View file
Open in desktop
Expand Up @@ -7,6 +7,7 @@
* [Usage](getting-started/usage.md)
* [General](general/README.md)
* [Responsive](general/responsive.md)
* [Pixel Ratio](general/device-pixel-ratio.md)
* [Interactions](general/interactions/README.md)
* [Events](general/interactions/events.md)
* [Modes](general/interactions/modes.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/axes/cartesian/README.md
View file
Open in desktop
Expand Up @@ -75,13 +75,13 @@ var myChart = new Chart(ctx, {
data: {
datasets: [{
data: [20, 50, 100, 75, 25, 0],
label: 'Left dataset'
label: 'Left dataset',

// This binds the dataset to the left y axis
yAxisID: 'left-y-axis'
}, {
data: [0.1, 0.5, 1.0, 2.0, 1.5, 0]
label: 'Right dataset'
data: [0.1, 0.5, 1.0, 2.0, 1.5, 0],
label: 'Right dataset',

// This binds the dataset to the right y axis
yAxisID: 'right-y-axis',
Expand Down
4 changes: 2 additions & 2 deletions docs/axes/cartesian/linear.md
View file
Open in desktop
Expand Up @@ -20,7 +20,7 @@ The following options are provided by the linear scale. They are all located in

Given the number of axis range settings, it is important to understand how they all interact with each other.

The `suggestedMax` and `suggestedMin` settings only change the data values that are used to scale the axis. These are useful for extending the range of the axis while maintaing the auto fit behaviour.
The `suggestedMax` and `suggestedMin` settings only change the data values that are used to scale the axis. These are useful for extending the range of the axis while maintaining the auto fit behaviour.

```javascript
let minDataValue = Math.min(mostNegativeValue, options.ticks.suggestedMin);
Expand All @@ -43,7 +43,7 @@ let chart = new Chart(ctx, {
scales: {
yAxes: [{
ticks: {
suggestedMin: 50
suggestedMin: 50,
suggestedMax: 100
}
}]
Expand Down
4 changes: 2 additions & 2 deletions docs/axes/radial/linear.md
View file
Open in desktop
Expand Up @@ -36,7 +36,7 @@ The following options are provided by the linear scale. They are all located in

Given the number of axis range settings, it is important to understand how they all interact with each other.

The `suggestedMax` and `suggestedMin` settings only change the data values that are used to scale the axis. These are useful for extending the range of the axis while maintaing the auto fit behaviour.
The `suggestedMax` and `suggestedMin` settings only change the data values that are used to scale the axis. These are useful for extending the range of the axis while maintaining the auto fit behaviour.

```javascript
let minDataValue = Math.min(mostNegativeValue, options.ticks.suggestedMin);
Expand All @@ -58,7 +58,7 @@ let chart = new Chart(ctx, {
options: {
scale: {
ticks: {
suggestedMin: 50
suggestedMin: 50,
suggestedMax: 100
}
}
Expand Down
4 changes: 2 additions & 2 deletions docs/axes/styling.md
View file
Open in desktop
Expand Up @@ -35,8 +35,8 @@ The tick configuration is nested under the scale configuration in the `ticks` ke
| `fontSize` | `Number` | `12` | Font size for the tick labels.
| `fontStyle` | `String` | `'normal'` | Font style for the tick labels, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
| `reverse` | `Boolean` | `false` | Reverses order of tick labels.
| `minor` | `object` | `{}` | Minor ticks configuration. Ommited options are inherited from options above.
| `major` | `object` | `{}` | Major ticks configuration. Ommited options are inherited from options above.
| `minor` | `object` | `{}` | Minor ticks configuration. Omitted options are inherited from options above.
| `major` | `object` | `{}` | Major ticks configuration. Omitted options are inherited from options above.

## Minor Tick Configuration
The minorTick configuration is nested under the ticks configuration in the `minor` key. It defines options for the minor tick marks that are generated by the axis. Omitted options are inherited from `ticks` configuration.
Expand Down
2 changes: 1 addition & 1 deletion docs/charts/line.md
View file
Open in desktop
Expand Up @@ -119,7 +119,7 @@ The `data` property of a dataset for a line chart can be passed in two formats.
data: [20, 10]
```

When the `data` array is an array of numbers, the x axis is generally a [category](../axes/cartesian/category.md#Category Axis). The points are placed onto the axis using their position in the array. When a line chart is created with a category axis, the `labels` property of the data object must be specified.
When the `data` array is an array of numbers, the x axis is generally a [category](../axes/cartesian/category.md#category-cartesian-axis). The points are placed onto the axis using their position in the array. When a line chart is created with a category axis, the `labels` property of the data object must be specified.

### Point[]

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/tooltip.md
View file
Open in desktop
Expand Up @@ -30,7 +30,7 @@ The tooltip configuration is passed into the `options.tooltips` namespace. The g
| `footerFontSize` | `Number` | `12` | Footer font size
| `footerFontStyle` | `String` | `'bold'` | Footer font style
| `footerFontColor` | `Color` | `'#fff'` | Footer font color
| `footerSpacing` | `Number` | `2` | Spacing to add to top and bottom of each fotter line.
| `footerSpacing` | `Number` | `2` | Spacing to add to top and bottom of each footer line.
| `footerMarginTop` | `Number` | `6` | Margin to add before drawing the footer.
| `xPadding` | `Number` | `6` | Padding to add on left and right of tooltip.
| `yPadding` | `Number` | `6` | Padding to add on top and bottom of tooltip.
Expand Down
4 changes: 2 additions & 2 deletions docs/developers/axes.md
View file
Open in desktop
Expand Up @@ -78,14 +78,14 @@ To work with Chart.js, custom scale types must implement the following interface

// Get the pixel (x coordinate for horizontal axis, y coordinate for vertical axis) for a given value
// @param index: index into the ticks array
// @param includeOffset: if true, get the pixel halway between the given tick and the next
// @param includeOffset: if true, get the pixel halfway between the given tick and the next
getPixelForTick: function(index, includeOffset) {},

// Get the pixel (x coordinate for horizontal axis, y coordinate for vertical axis) for a given value
// @param value : the value to get the pixel for
// @param index : index into the data array of the value
// @param datasetIndex : index of the dataset the value comes from
// @param includeOffset : if true, get the pixel halway between the given tick and the next
// @param includeOffset : if true, get the pixel halfway between the given tick and the next
getPixelForValue: function(value, index, datasetIndex, includeOffset) {}

// Get the value for a given pixel (x coordinate for horizontal axis, y coordinate for vertical axis)
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/README.md
View file
Open in desktop
Expand Up @@ -40,4 +40,4 @@ var chart = new Chart(ctx, {

It's that easy to get started using Chart.js! From here you can explore the many options that can help you customise your charts with scales, tooltips, labels, colors, custom actions, and much more.

There are many examples of Chart.js that are available in the `/samples` folder of `Chart.js.zip` that is attatched to every [release](https://github.com/chartjs/Chart.js/releases).
There are many examples of Chart.js that are available in the `/samples` folder of `Chart.js.zip` that is attached to every [release](https://github.com/chartjs/Chart.js/releases).
2 changes: 1 addition & 1 deletion docs/getting-started/installation.md
View file
Open in desktop
Expand Up @@ -36,7 +36,7 @@ https://www.jsdelivr.com/package/npm/chart.js?path=dist

You can download the latest version of [Chart.js on GitHub](https://github.com/chartjs/Chart.js/releases/latest).

If you download or clone the repository, you must [build](../developers/contributing.md#building-chartjs) Chart.js to generate the dist files. Chart.js no longer comes with prebuilt release versions, so an alternative option to downloading the repo is **strongly** advised.
If you download or clone the repository, you must [build](../developers/contributing.md#building-and-testing) Chart.js to generate the dist files. Chart.js no longer comes with prebuilt release versions, so an alternative option to downloading the repo is **strongly** advised.

# Selecting the Correct Build

Expand Down