Skip to content

Commit 32a660f

Browse files
authored
Fix typos in docs (#410)
* Fix typos in docs * Delete unintentional copy of defaults.fsx
1 parent 9845b4d commit 32a660f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+153
-151
lines changed

docs/3D-charts/3d-isosurface-plots.fsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to create 3D-IsoSurface charts in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
*)
3737

3838
open System

docs/3D-charts/3d-mesh-plots.fsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to create 3D-Mesh charts in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
*)
3737

3838
open System

docs/3D-charts/3d-scatter-plots.fsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3434
3535
*Summary:* This example shows how to create three-dimensional point and line charts in F#.
3636
37-
Point3D, Line3D, and Bubble3D charts are all derived from `Chart.Scatter3D` and can be generated by that function as well.
37+
Point3D, Line3D, and Bubble3D charts are all derived from `Chart.Scatter3D` and can be generated by that function, as well.
3838
However, `Chart.Point3D`, `Chart.Line3D`, or `Chart.Bubble3D` provide sensible defaults and arguments for the respective derived chart, and are recommended to use.
3939
4040
## 3D point chart

docs/3D-charts/3d-streamtube-plots.fsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3333
3434
*Summary:* This example shows how to create 3D-StreamTube charts in F#.
3535
36-
let's first create some data for the purpose of creating example charts:
36+
Let's first create some data for the purpose of creating example charts:
3737
*)
3838

3939
open Deedle

docs/3D-charts/3d-surface-plots.fsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to create 3D surface plots in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
*)
3737
open System
3838
open Plotly.NET

docs/3D-charts/3d-volume-plots.fsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to create 3D-Volume charts in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
*)
3737

3838
open System

docs/carpet-charts/carpet_line_scatter_plots.fsx

+7-7
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3333
3434
*Summary:* This example shows how to create carpet charts in F#.
3535
36-
let's first create some data for the purpose of creating example charts:
36+
Let's first create some data for the purpose of creating example charts:
3737
3838
*)
3939

@@ -56,7 +56,7 @@ Besides the ability to incorporate more variables, another feature that distingu
5656
5757
A conventional carpet plot can capture the interaction of up to three independent variables and three dependent variables and still be easily read and interpolated.
5858
59-
Carpet plots have common applications within areas such as material science for showing elastic modulus in laminates,and within aeronautics.
59+
Carpet plots have common applications within areas such as material science for showing elastic modulus in laminates, and within aeronautics.
6060
6161
A carpet plot with two independent variables and one dependent variable is often called a cheater plot for the use of a phantom "cheater" axis instead of the horizontal axis.
6262
@@ -66,7 +66,7 @@ A carpet plot with two independent variables and one dependent variable is often
6666
6767
In plotly, carpet plots are different to all other trace types in the regard that the coordinate system of the carpet is not set on the layout, but is itself a trace.
6868
69-
Use `Chart.Carpet` to define these `coordinate traces`. All carpets have a mandatory identifier, which will be used by other traces to define which carpet coordinate system to use.
69+
Use `Chart.Carpet` to define these `coordinate traces`. All carpets have a mandatory identifier which will be used by other traces to define which carpet coordinate system to use.
7070
*)
7171

7272
let carpet = Chart.Carpet(carpetId = "carpetIdentifier", A = a, B = b, Y = y)
@@ -83,7 +83,7 @@ carpet |> GenericChart.toChartHTML
8383
(**
8484
## Carpet point charts
8585
86-
use `Chart.PointCarpet` to create a point plot on the referenced carpet coordinate system:
86+
Use `Chart.PointCarpet` to create a point plot on the referenced carpet coordinate system:
8787
*)
8888
let carpetPoint =
8989
[ carpet
@@ -102,7 +102,7 @@ carpetPoint |> GenericChart.toChartHTML
102102
(**
103103
## Carpet line charts
104104
105-
use `Chart.LineCarpet` to create a line plot on the referenced carpet coordinate system:
105+
Use `Chart.LineCarpet` to create a line plot on the referenced carpet coordinate system:
106106
*)
107107

108108
let carpetLine =
@@ -122,7 +122,7 @@ carpetLine |> GenericChart.toChartHTML
122122
(**
123123
## Carpet Spline charts
124124
125-
use `Chart.LineCarpet` to create a spline plot on the referenced carpet coordinate system:
125+
Use `Chart.LineCarpet` to create a spline plot on the referenced carpet coordinate system:
126126
*)
127127

128128
let carpetSpline =
@@ -142,7 +142,7 @@ carpetSpline |> GenericChart.toChartHTML
142142
(**
143143
## Carpet bubble charts
144144
145-
use `Chart.LineCarpet` to create a bubble plot on the referenced carpet coordinate system:
145+
Use `Chart.LineCarpet` to create a bubble plot on the referenced carpet coordinate system:
146146
*)
147147

148148
let carpetBubble =

docs/categorical-charts/icicle.fsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3737
Icicle charts visualize hierarchical data using rectangular sectors that cascade from root to leaves in one of four directions: up, down, left, or right.
3838
Similar to Sunburst charts and Treemaps charts, the hierarchy is defined by labels and parents attributes.
3939
Click on one sector to zoom in/out, which also displays a pathbar on the top of your icicle.
40-
To zoom out, you can click the parent sector or click the pathbar as well.
40+
To zoom out, you can click the parent sector or click the pathbar, as well.
4141
*)
4242

4343
open Plotly.NET
@@ -71,7 +71,7 @@ icicle |> GenericChart.toChartHTML
7171
(**
7272
## More styled example
7373
74-
This example shows the usage of some of the styling possibility using `Chart.Icicle`.
74+
This example shows the usage of some of the styling options using `Chart.Icicle`.
7575
For even more styling control, use the respective TraceStyle function `TraceDomainStyle.Icicle`
7676
*)
7777

docs/categorical-charts/parallel-categories.fsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ parcats |> GenericChart.toChartHTML
6262
(**
6363
## More styled example
6464
65-
This example shows the usage of some of the styling possibility using `Chart.ParallelCategories`.
65+
This example shows the usage of some of the styling options using `Chart.ParallelCategories`.
6666
For even more styling control, use the respective TraceStyle function `TraceDomainStyle.ParallelCategories`
6767
*)
6868

docs/categorical-charts/parallel-coords.fsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3434
3535
*Summary:* This example shows how to create parallel coordinates plot in F#.
3636
37-
let's first create some data for the purpose of creating example charts:
37+
Let's first create some data for the purpose of creating example charts:
3838
3939
*)
4040

@@ -69,7 +69,7 @@ parcoords1 |> GenericChart.toChartHTML
6969
(**
7070
## More styled example
7171
72-
This example shows the usage of some of the styling possibility using `Chart.ParallelCoord`.
72+
This example shows the usage of some of the styling options using `Chart.ParallelCoord`.
7373
For even more styling control, use the respective TraceStyle function `TraceDomainStyle.ParallelCoord`
7474
*)
7575

docs/categorical-charts/sunburst.fsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3333
3434
*Summary:* This example shows how to create sunburst charts in F#.
3535
36-
Sunburst Chartalso known as Ring Chart, Multi-level Pie Chart, and Radial Treemap is typically used to visualize hierarchical data structures.
36+
Sunburst Chart, also known as Ring Chart, Multi-level Pie Chart, and Radial Treemap, is typically used to visualize hierarchical data structures.
3737
A Sunburst Chart consists of an inner circle surrounded by rings of deeper hierarchy levels.
3838
The angle of each segment is either proportional to a value or divided equally under its parent node.
3939
@@ -55,7 +55,7 @@ let sunburstChart =
5555
(**
5656
## More styled example
5757
58-
This example shows the usage of some of the styling possibility using `Chart.Sunburst`.
58+
This example shows the usage of some of the styling options using `Chart.Sunburst`.
5959
For even more styling control, use the respective TraceStyle function `TraceDomainStyle.Sunburst`
6060
*)
6161

docs/categorical-charts/treemap.fsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The space inside each of the rectangles that compose a Treemap is highlighted ba
3939
4040
## Treemap example
4141
42-
This example shows the usage of some of the styling possibility using `Chart.Treemap`.
42+
This example shows the usage of some of the styling options using `Chart.Treemap`.
4343
For even more styling control, use the respective TraceStyle function `TraceDomainStyle.Treemap`
4444
*)
4545

docs/chart-layout/annotations.fsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to create Shapes and add them to the Charts in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
3737
*)
3838

@@ -42,7 +42,7 @@ let x = [ 1.; 2.; 3.; 4.; 5.; 6.; 7.; 8.; 9.; 10. ]
4242
let y = [ 2.; 1.5; 5.; 1.5; 3.; 2.5; 2.5; 1.5; 3.5; 1. ]
4343

4444
(**
45-
use the `Annotation.init` function to generate a shape, and either the `Chart.withAnnotation` or the `Chart.withAnnotations` function to add
45+
Use the `Annotation.init` function to generate a shape, and either the `Chart.withAnnotation` or the `Chart.withAnnotations` function to add
4646
multiple annotations at once.
4747
4848
*)

docs/chart-layout/axis-styling.fsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to style chart axes in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
*)
3737

3838
open Plotly.NET
@@ -62,7 +62,7 @@ plot1 |> GenericChart.toChartHTML
6262
(***include-it-raw***)
6363

6464
(**
65-
for even more fine-grained control, initialize a new axis and replace the old one of the plot with ````.
65+
For even more fine-grained control, initialize a new axis and replace the old one of the plot with `Chart.with*_Axis`.
6666
The following example creates two mirrored axes with inside ticks, one of them with a log scale:
6767
*)
6868

docs/chart-layout/errorbars.fsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to add error bars to plots in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
3737
*)
3838

docs/chart-layout/layout_images.fsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to create Images and add them to the Charts in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
3737
*)
3838

@@ -42,7 +42,7 @@ let x = [ 1.; 2.; 3.; 4.; 5.; 6.; 7.; 8.; 9.; 10. ]
4242
let y = [ 2.; 1.5; 5.; 1.5; 3.; 2.5; 2.5; 1.5; 3.5; 1. ]
4343

4444
(**
45-
use the `LayoutImage.init` function to generate an image, and either the `Chart.withLayoutImage` or the `Chart.withLayoutImages` function to add
45+
Use the `LayoutImage.init` function to generate an image, and either the `Chart.withLayoutImage` or the `Chart.withLayoutImages` function to add
4646
multiple annotations at once.
4747
4848
*)

docs/chart-layout/multiple-charts.fsx

+8-8
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to create charts with multiple subplots in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
3737
*)
3838

@@ -71,7 +71,7 @@ combinedChart |> GenericChart.toChartHTML
7171
7272
`Chart.Grid` creates a subplot grid. There are two overloads:
7373
74-
You can either use Chart.Grid with a 1 dimensional sequence of Charts and specify the amount of rows and columns:
74+
You can either use Chart.Grid with a 1 dimensional sequence of Charts and specify the number of rows and columns:
7575
7676
*)
7777

@@ -133,8 +133,8 @@ grid2 |> GenericChart.toChartHTML
133133

134134
(**
135135
To leave cells of the grid empty, you have to fill it with dummy charts via `Chart.Invisible()`.
136-
Pleas enote that when using a 2D sequence with unequal amounts of charts in the rows, the column amount will be set
137-
to the row with the highest amount of charts, and the other rows will be filled by invisible charts to the right.
136+
Pleas note that when using a 2D sequence with unequal numbers of charts in the rows, the column count will be set
137+
to the row with the highest number of charts, and the other rows will be filled by invisible charts to the right.
138138
*)
139139

140140
//simple 2x2 subplot grid with an empty cell at position 1,2
@@ -164,7 +164,7 @@ grid3 |> GenericChart.toChartHTML
164164
(***include-it-raw***)
165165

166166
(**
167-
use `Pattern=StyleParam.LayoutGridPatter.Coupled` to use one shared x axis per column and one shared y axis per row.
167+
Use `Pattern=StyleParam.LayoutGridPatter.Coupled` to use one shared x axis per column and one shared y axis per row.
168168
(Try zooming in the single subplots below)
169169
*)
170170

@@ -196,7 +196,7 @@ grid4 |> GenericChart.toChartHTML
196196
### Chart.SingleStack
197197
198198
The `Chart.SingleStack` function is a special version of Chart.Grid that creates only one column from a 1D input chart sequence.
199-
It uses a shared x axis per default.
199+
It uses a shared x axis by default.
200200
201201
As with all grid charts, you can also use the Chart.withLayoutGridStyle to style subplot grids:
202202
@@ -228,7 +228,7 @@ singleStack |> GenericChart.toChartHTML
228228
229229
Chart.Grid does some internal magic to make sure that all trace types get their grid cell according to plotly.js's inner logic.
230230
231-
The only thing you have to consider is, that when you are using nested combined charts, that these have to have the same trace type.
231+
The only thing you have to consider is that when you are using nested combined charts, they have to have the same trace type.
232232
233233
Otherwise, you can freely combine all charts with Chart.Grid:
234234
@@ -324,7 +324,7 @@ multipleTraceTypesGrid |> GenericChart.toChartHTML
324324
(***include-it-raw***)
325325

326326
(**
327-
If you are not sure if traceTypes are compatible, look at the `TraceIDs`:
327+
If you are not sure if trace types are compatible, look at the `TraceIDs`:
328328
*)
329329

330330
let pointType = Chart.Point(xy = [ 1, 2 ]) |> GenericChart.getTraceID

docs/chart-layout/shapes.fsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to create Shapes and add them to the Charts in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
3737
*)
3838

@@ -42,7 +42,7 @@ let x = [ 1.; 2.; 3.; 4.; 5.; 6.; 7.; 8.; 9.; 10. ]
4242
let y' = [ 2.; 1.5; 5.; 1.5; 3.; 2.5; 2.5; 1.5; 3.5; 1. ]
4343

4444
(**
45-
use the `Shape.init` function to generate a shape, and either the `Chart.withShape` or the `Chart.withShapes` function to add
45+
Use the `Shape.init` function to generate a shape, and either the `Chart.withShape` or the `Chart.withShapes` function to add
4646
multiple shapes at once.
4747
4848
**Attention**: Adding a shape after you added a previous one currently removes the old one. This is a bug and will be fixed

docs/chart-layout/sliders.fsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3434
3535
The sliders give the option of passing the arguments to the Plotly chart. In the example we use the visibility parameter to make the step chosen in the slider visible.
3636
37-
The original exapmle is made with python and can be found [here](https://plotly.com/python/sliders)
37+
The original example is written in Python and can be found [here](https://plotly.com/python/sliders)
3838
*)
3939

4040
open Plotly.NET
@@ -78,7 +78,7 @@ let sliderSteps =
7878
steps
7979
|> Seq.indexed
8080
|> Seq.map (fun (i, step) ->
81-
// Create a visibility and a title parameters
81+
// Create a visibility and a title parameter
8282
// The visibility parameter includes an array where every parameter
8383
// is mapped onto the trace visibility
8484
let visible =

docs/distribution-charts/2d-histograms.fsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to create a bi-dimensional histogram of two data samples in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
*)
3737

3838
open Plotly.NET

docs/distribution-charts/box-plots.fsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to create boxplot charts in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
*)
3737

3838
open Plotly.NET
@@ -71,7 +71,7 @@ box1 |> GenericChart.toChartHTML
7171
(***include-it-raw***)
7272

7373
(**
74-
By swapping x and y plus using `StyleParam.Orientation.Horizontal` we can flip the chart horizontaly.
74+
By swapping x and y plus using `StyleParam.Orientation.Horizontal`, we can flip the chart horizontally.
7575
*)
7676
let box2 =
7777
Chart.BoxPlot(

docs/distribution-charts/contour-plots.fsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
3232
3333
*Summary:* This example shows how to create contour plot in F#.
3434
35-
let's first create some data for the purpose of creating example charts:
35+
Let's first create some data for the purpose of creating example charts:
3636
3737
*)
3838

@@ -79,7 +79,7 @@ contour1 |> GenericChart.toChartHTML
7979
(**
8080
## Smooth Contour Coloring
8181
82-
to apply heatmap gradient coloring between each contour level, set the `ContourColoring` to `heatmap`:
82+
To apply heatmap gradient coloring between each contour level, set the `ContourColoring` to `heatmap`:
8383
*)
8484

8585
let contour2 =

0 commit comments

Comments
 (0)