Skip to content

Commit

Permalink
Fix typos in docs (#410)
Browse files Browse the repository at this point in the history
* Fix typos in docs

* Delete unintentional copy of defaults.fsx
  • Loading branch information
chausner authored Aug 11, 2023
1 parent 9845b4d commit 32a660f
Show file tree
Hide file tree
Showing 66 changed files with 153 additions and 151 deletions.
2 changes: 1 addition & 1 deletion docs/3D-charts/3d-isosurface-plots.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create 3D-IsoSurface charts in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

open System
Expand Down
2 changes: 1 addition & 1 deletion docs/3D-charts/3d-mesh-plots.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create 3D-Mesh charts in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

open System
Expand Down
2 changes: 1 addition & 1 deletion docs/3D-charts/3d-scatter-plots.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create three-dimensional point and line charts in F#.
Point3D, Line3D, and Bubble3D charts are all derived from `Chart.Scatter3D` and can be generated by that function as well.
Point3D, Line3D, and Bubble3D charts are all derived from `Chart.Scatter3D` and can be generated by that function, as well.
However, `Chart.Point3D`, `Chart.Line3D`, or `Chart.Bubble3D` provide sensible defaults and arguments for the respective derived chart, and are recommended to use.
## 3D point chart
Expand Down
2 changes: 1 addition & 1 deletion docs/3D-charts/3d-streamtube-plots.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create 3D-StreamTube charts in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

open Deedle
Expand Down
2 changes: 1 addition & 1 deletion docs/3D-charts/3d-surface-plots.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create 3D surface plots in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)
open System
open Plotly.NET
Expand Down
2 changes: 1 addition & 1 deletion docs/3D-charts/3d-volume-plots.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create 3D-Volume charts in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

open System
Expand Down
14 changes: 7 additions & 7 deletions docs/carpet-charts/carpet_line_scatter_plots.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create carpet charts in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

Expand All @@ -56,7 +56,7 @@ Besides the ability to incorporate more variables, another feature that distingu
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.
Carpet plots have common applications within areas such as material science for showing elastic modulus in laminates,and within aeronautics.
Carpet plots have common applications within areas such as material science for showing elastic modulus in laminates, and within aeronautics.
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.
Expand All @@ -66,7 +66,7 @@ A carpet plot with two independent variables and one dependent variable is often
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.
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.
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.
*)

let carpet = Chart.Carpet(carpetId = "carpetIdentifier", A = a, B = b, Y = y)
Expand All @@ -83,7 +83,7 @@ carpet |> GenericChart.toChartHTML
(**
## Carpet point charts
use `Chart.PointCarpet` to create a point plot on the referenced carpet coordinate system:
Use `Chart.PointCarpet` to create a point plot on the referenced carpet coordinate system:
*)
let carpetPoint =
[ carpet
Expand All @@ -102,7 +102,7 @@ carpetPoint |> GenericChart.toChartHTML
(**
## Carpet line charts
use `Chart.LineCarpet` to create a line plot on the referenced carpet coordinate system:
Use `Chart.LineCarpet` to create a line plot on the referenced carpet coordinate system:
*)

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

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

let carpetBubble =
Expand Down
4 changes: 2 additions & 2 deletions docs/categorical-charts/icicle.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
Icicle charts visualize hierarchical data using rectangular sectors that cascade from root to leaves in one of four directions: up, down, left, or right.
Similar to Sunburst charts and Treemaps charts, the hierarchy is defined by labels and parents attributes.
Click on one sector to zoom in/out, which also displays a pathbar on the top of your icicle.
To zoom out, you can click the parent sector or click the pathbar as well.
To zoom out, you can click the parent sector or click the pathbar, as well.
*)

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

Expand Down
2 changes: 1 addition & 1 deletion docs/categorical-charts/parallel-categories.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ parcats |> GenericChart.toChartHTML
(**
## More styled example
This example shows the usage of some of the styling possibility using `Chart.ParallelCategories`.
This example shows the usage of some of the styling options using `Chart.ParallelCategories`.
For even more styling control, use the respective TraceStyle function `TraceDomainStyle.ParallelCategories`
*)

Expand Down
4 changes: 2 additions & 2 deletions docs/categorical-charts/parallel-coords.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create parallel coordinates plot in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

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

Expand Down
4 changes: 2 additions & 2 deletions docs/categorical-charts/sunburst.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create sunburst charts in F#.
Sunburst Chartalso known as Ring Chart, Multi-level Pie Chart, and Radial Treemap is typically used to visualize hierarchical data structures.
Sunburst Chart, also known as Ring Chart, Multi-level Pie Chart, and Radial Treemap, is typically used to visualize hierarchical data structures.
A Sunburst Chart consists of an inner circle surrounded by rings of deeper hierarchy levels.
The angle of each segment is either proportional to a value or divided equally under its parent node.
Expand All @@ -55,7 +55,7 @@ let sunburstChart =
(**
## More styled example
This example shows the usage of some of the styling possibility using `Chart.Sunburst`.
This example shows the usage of some of the styling options using `Chart.Sunburst`.
For even more styling control, use the respective TraceStyle function `TraceDomainStyle.Sunburst`
*)

Expand Down
2 changes: 1 addition & 1 deletion docs/categorical-charts/treemap.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The space inside each of the rectangles that compose a Treemap is highlighted ba
## Treemap example
This example shows the usage of some of the styling possibility using `Chart.Treemap`.
This example shows the usage of some of the styling options using `Chart.Treemap`.
For even more styling control, use the respective TraceStyle function `TraceDomainStyle.Treemap`
*)

Expand Down
4 changes: 2 additions & 2 deletions docs/chart-layout/annotations.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create Shapes and add them to the Charts in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

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

(**
use the `Annotation.init` function to generate a shape, and either the `Chart.withAnnotation` or the `Chart.withAnnotations` function to add
Use the `Annotation.init` function to generate a shape, and either the `Chart.withAnnotation` or the `Chart.withAnnotations` function to add
multiple annotations at once.
*)
Expand Down
4 changes: 2 additions & 2 deletions docs/chart-layout/axis-styling.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to style chart axes in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

open Plotly.NET
Expand Down Expand Up @@ -62,7 +62,7 @@ plot1 |> GenericChart.toChartHTML
(***include-it-raw***)

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

Expand Down
2 changes: 1 addition & 1 deletion docs/chart-layout/errorbars.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to add error bars to plots in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

Expand Down
4 changes: 2 additions & 2 deletions docs/chart-layout/layout_images.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create Images and add them to the Charts in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

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

(**
use the `LayoutImage.init` function to generate an image, and either the `Chart.withLayoutImage` or the `Chart.withLayoutImages` function to add
Use the `LayoutImage.init` function to generate an image, and either the `Chart.withLayoutImage` or the `Chart.withLayoutImages` function to add
multiple annotations at once.
*)
Expand Down
16 changes: 8 additions & 8 deletions docs/chart-layout/multiple-charts.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create charts with multiple subplots in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

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

Expand Down Expand Up @@ -133,8 +133,8 @@ grid2 |> GenericChart.toChartHTML

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

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

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

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

(**
If you are not sure if traceTypes are compatible, look at the `TraceIDs`:
If you are not sure if trace types are compatible, look at the `TraceIDs`:
*)

let pointType = Chart.Point(xy = [ 1, 2 ]) |> GenericChart.getTraceID
Expand Down
4 changes: 2 additions & 2 deletions docs/chart-layout/shapes.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create Shapes and add them to the Charts in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

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

(**
use the `Shape.init` function to generate a shape, and either the `Chart.withShape` or the `Chart.withShapes` function to add
Use the `Shape.init` function to generate a shape, and either the `Chart.withShape` or the `Chart.withShapes` function to add
multiple shapes at once.
**Attention**: Adding a shape after you added a previous one currently removes the old one. This is a bug and will be fixed
Expand Down
4 changes: 2 additions & 2 deletions docs/chart-layout/sliders.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
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.
The original exapmle is made with python and can be found [here](https://plotly.com/python/sliders)
The original example is written in Python and can be found [here](https://plotly.com/python/sliders)
*)

open Plotly.NET
Expand Down Expand Up @@ -78,7 +78,7 @@ let sliderSteps =
steps
|> Seq.indexed
|> Seq.map (fun (i, step) ->
// Create a visibility and a title parameters
// Create a visibility and a title parameter
// The visibility parameter includes an array where every parameter
// is mapped onto the trace visibility
let visible =
Expand Down
2 changes: 1 addition & 1 deletion docs/distribution-charts/2d-histograms.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create a bi-dimensional histogram of two data samples in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

open Plotly.NET
Expand Down
4 changes: 2 additions & 2 deletions docs/distribution-charts/box-plots.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create boxplot charts in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

open Plotly.NET
Expand Down Expand Up @@ -71,7 +71,7 @@ box1 |> GenericChart.toChartHTML
(***include-it-raw***)

(**
By swapping x and y plus using `StyleParam.Orientation.Horizontal` we can flip the chart horizontaly.
By swapping x and y plus using `StyleParam.Orientation.Horizontal`, we can flip the chart horizontally.
*)
let box2 =
Chart.BoxPlot(
Expand Down
4 changes: 2 additions & 2 deletions docs/distribution-charts/contour-plots.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Plotly.NET.Defaults.DefaultDisplayOptions <-
*Summary:* This example shows how to create contour plot in F#.
let's first create some data for the purpose of creating example charts:
Let's first create some data for the purpose of creating example charts:
*)

Expand Down Expand Up @@ -79,7 +79,7 @@ contour1 |> GenericChart.toChartHTML
(**
## Smooth Contour Coloring
to apply heatmap gradient coloring between each contour level, set the `ContourColoring` to `heatmap`:
To apply heatmap gradient coloring between each contour level, set the `ContourColoring` to `heatmap`:
*)

let contour2 =
Expand Down
Loading

0 comments on commit 32a660f

Please sign in to comment.