]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Fix typos and broken links in the docs (#5010)
authorbeiz23 <vdmillau@gmail.com>
Thu, 30 Nov 2017 13:41:32 +0000 (22:41 +0900)
committerSimon Brunel <simonbrunel@users.noreply.github.com>
Thu, 30 Nov 2017 13:41:32 +0000 (14:41 +0100)
docs/SUMMARY.md
docs/axes/cartesian/README.md
docs/axes/cartesian/linear.md
docs/axes/radial/linear.md
docs/axes/styling.md
docs/charts/line.md
docs/configuration/tooltip.md
docs/developers/axes.md
docs/getting-started/README.md
docs/getting-started/installation.md

index 606300900034d107916bedd456cc17c5708f5f3c..8591dad86ae66ad60698ae9e7de3fd6ec26f279d 100644 (file)
@@ -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)
index 64ce32073c20f3fb1a3268e5994e7986003dfbb8..8518da9f25020de62a12b3f57ff70488041b1bdd 100644 (file)
@@ -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',
index 00f7aced1fe152abe6017e749724d0c9cb3d3d20..1d0292074a808926ebdd44dfd938dbef4dfb5154 100644 (file)
@@ -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);
@@ -43,7 +43,7 @@ let chart = new Chart(ctx, {
         scales: {
             yAxes: [{
                 ticks: {
-                    suggestedMin: 50
+                    suggestedMin: 50,
                     suggestedMax: 100
                 }
             }]
index 1636781a84e56278934b75c139863c57573d0393..adebe77cc61b62a0933620ab6f3f8d01d9b737da 100644 (file)
@@ -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);
@@ -58,7 +58,7 @@ let chart = new Chart(ctx, {
     options: {
         scale: {
             ticks: {
-                suggestedMin: 50
+                suggestedMin: 50,
                 suggestedMax: 100
             }
         }
index 1de31e01f6c19da174cf25e10d1085923b59c9cf..f60afd9bb68a80fed5337e1fc40f6368bc3d8349 100644 (file)
@@ -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.
index 40441b7afe3e5d3f20f15d0dcf1eef477e2334c9..90471e462dd8a289c5f433e82c1c9e84d693a96c 100644 (file)
@@ -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[]
 
index 51004843a33390b8d03fbfff40c04e8b9c71a527..1be2c26bc0edc8ced296a57dc82ddfca88de7d04 100644 (file)
@@ -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.
index 8d120195ae93ade1bd7806d13e2143c78a0fb2b6..7d6c74e32c943c4005ad631e7035e4b7f8af266d 100644 (file)
@@ -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)
index 9266b309938d54a2c4e8ef134d46924d8e37dcb8..bff52c72dd6fde920ff8a5e1ffea0960a5626ff4 100644 (file)
@@ -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).
\ No newline at end of file
+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).
\ No newline at end of file
index c8291d260c27b6c5f713dffd18f2f1f669030a15..613d7aa7a6cce585397e0cd3a4fb4f4d09e52dd0 100644 (file)
@@ -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