stay on .net 6, update fantomas, format /src and /docs

Author: kMutagene

.config/dotnet-tools.json

@@ -2,14 +2,14 @@
   "version": 1,
   "isRoot": true,
   "tools": {
-    "fantomas-tool": {
-      "version": "4.7.9",
+    "fantomas": {
+      "version": "5.2.2",
       "commands": [
         "fantomas"
       ]
     },
     "fsdocs-tool": {
-      "version": "17.2.2",
+      "version": "16.1.1",
       "commands": [
         "fsdocs"
       ]

docs/00_0_basics.fsx

@@ -16,7 +16,8 @@ index: 1
 #r "nuget: Giraffe.ViewEngine, 1.4.0"
 #r "../src/Plotly.NET/bin/Release/netstandard2.0/Plotly.NET.dll"
 
-Plotly.NET.Defaults.DefaultDisplayOptions <- Plotly.NET.DisplayOptions.init(PlotlyJSReference = Plotly.NET.PlotlyJSReference.NoReference)
+Plotly.NET.Defaults.DefaultDisplayOptions <-
+    Plotly.NET.DisplayOptions.init (PlotlyJSReference = Plotly.NET.PlotlyJSReference.NoReference)
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -85,8 +86,7 @@ Here is an example on how to create a simple 2D point chart:
 
 open Plotly.NET
 
-let pointChart =
-    Chart.Point(xy=[1,2; 3,4])
+let pointChart = Chart.Point(xy = [ 1, 2; 3, 4 ])
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -110,12 +110,7 @@ You can clearly see the advantages and disadvantages of both approaches.
 *)
 
 let withTraceStyle =
-    Trace2D.initScatter( 
-        Trace2DStyle.Scatter(
-            X = [1; 3],
-            Y = [2; 4]
-        )
-    )
+    Trace2D.initScatter (Trace2DStyle.Scatter(X = [ 1; 3 ], Y = [ 2; 4 ]))
     |> GenericChart.ofTraceObject true
 
 (*** condition: ipynb ***)
@@ -141,8 +136,8 @@ So if you want to set any kind of property on one of these objects you can do it
 *)
 
 let myTrace = Trace("scatter") // create a scatter trace
-myTrace?x <- [0;3] // set the x property (the x dimension of the data)
-myTrace?y <- [2;4] // set the y property (the y dimension of the data)
+myTrace?x <- [ 0; 3 ] // set the x property (the x dimension of the data)
+myTrace?y <- [ 2; 4 ] // set the y property (the y dimension of the data)
 
 let withDynObj = GenericChart.ofTraceObject true myTrace
 
@@ -162,4 +157,4 @@ lets have a look at the trace object that will be created. The relevant section
 var data = [{"type":"scatter","x":[0,1,2],"y":[0,1,2]}];
 ```
 
-*)
+*)

docs/00_1_image-export.fsx

@@ -64,19 +64,12 @@ The parameters for all three functions are exactly the same.
 open Plotly.NET
 open Plotly.NET.ImageExport
 
-let exampleChart = 
-    Chart.Histogram2DContour(
-        [1.;2.;2.;4.;5.],
-        [1.;2.;2.;4.;5.]
-    )
+let exampleChart =
+    Chart.Histogram2DContour([ 1.; 2.; 2.; 4.; 5. ], [ 1.; 2.; 2.; 4.; 5. ])
 
 (***do-not-eval***)
 exampleChart
-|> Chart.saveJPG(
-    "/your/path/without/extension/here",
-    Width=300,
-    Height=300
-)
+|> Chart.saveJPG ("/your/path/without/extension/here", Width = 300, Height = 300)
 
 (**
 ## Generating URIs for static chart images
@@ -92,12 +85,7 @@ By referencing the `Plotly.NET.ImageExport` package, you get access to:
 *)
 
 (***do-not-eval***)
-let base64JPG =
-    exampleChart
-    |> Chart.toBase64JPGString(
-        Width=300,
-        Height=300
-    )
+let base64JPG = exampleChart |> Chart.toBase64JPGString (Width = 300, Height = 300)
 
 (**
 It is very easy to construct a html tag that includes this image via a base64 uri. For SVGs, 
@@ -107,4 +95,4 @@ not even that is necessary and just the SVG string can be used.
 (***do-not-eval***)
 $"""<img
     src= "{base64JPG}"
-/>"""
+/>"""

docs/00_2_display-options.fsx

@@ -15,7 +15,8 @@ index: 3
 #r "nuget: Giraffe.ViewEngine, 1.4.0"
 #r "../src/Plotly.NET/bin/Release/netstandard2.0/Plotly.NET.dll"
 
-Plotly.NET.Defaults.DefaultDisplayOptions <- Plotly.NET.DisplayOptions.init(PlotlyJSReference = Plotly.NET.PlotlyJSReference.NoReference)
+Plotly.NET.Defaults.DefaultDisplayOptions <-
+    Plotly.NET.DisplayOptions.init (PlotlyJSReference = Plotly.NET.PlotlyJSReference.NoReference)
 
 
 (*** condition: ipynb ***)
@@ -41,10 +42,10 @@ let's first create some data for the purpose of creating example charts:
 
 *)
 
-open Plotly.NET 
-  
-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.]
+open Plotly.NET
+
+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. ]
 
 (**
 ## Referencing PlotlyJS
@@ -64,9 +65,7 @@ You can control this on a per-chart basis via `Chart.withDisplayOptionsStyle`, f
 
 (***do-not-eval***)
 Chart.Point(x = x, y = y)
-|> Chart.withDisplayOptionsStyle(
-    PlotlyJSReference = Full
-)
+|> Chart.withDisplayOptionsStyle (PlotlyJSReference = Full)
 
 
 (**
@@ -80,19 +79,11 @@ For example, use `Chart.withDescription` to append a list of html tags below the
 open Giraffe.ViewEngine
 
 let desc1 =
-    Chart.Point(
-        x = x, 
-        y = y,
-        Name="desc1"
-    )    
-    |> Chart.withDescription [
-        h1 [] [str "Hello"]
-        p [] [str "F#"]
-        ol [] [
-            li [] [str "Item 1"]
-            li [] [str "Item 2"]
-        ]
-    ]
+    Chart.Point(x = x, y = y, Name = "desc1")
+    |> Chart.withDescription
+        [ h1 [] [ str "Hello" ]
+          p [] [ str "F#" ]
+          ol [] [ li [] [ str "Item 1" ]; li [] [ str "Item 2" ] ] ]
 
 
 (*** condition: ipynb ***)
@@ -115,28 +106,22 @@ For example, you can load external css libraries to style the chart description:
 *)
 
 //html for description containing bulma classes such as "hero"
-let bulmaHero = 
-    section [_class"hero is-primary is-bold"] [
-        div [_class "hero-body"] [
-            p [_class "title"] [str "Hero title"]
-            p [_class "subtitle"] [str "Hero subtitle"]
-        ]
-    ]
+let bulmaHero =
+    section
+        [ _class "hero is-primary is-bold" ]
+        [ div
+              [ _class "hero-body" ]
+              [ p [ _class "title" ] [ str "Hero title" ]
+                p [ _class "subtitle" ] [ str "Hero subtitle" ] ] ]
 // chart description containing bulma classes
-let description3 = [
-    h1 [_class "title"] [str "I am heading"]
-    bulmaHero
-]
+let description3 = [ h1 [ _class "title" ] [ str "I am heading" ]; bulmaHero ]
 
 let desc3 =
-    Chart.Point(
-        x = x, 
-        y = y,
-        Name="desc3"
-    )    
-    |> Chart.withAdditionalHeadTags [
-        link [_rel "stylesheet"; _href "https://cdn.jsdelivr.net/npm/bulma@0.9.2/css/bulma.min.css"]
-    ]
+    Chart.Point(x = x, y = y, Name = "desc3")
+    |> Chart.withAdditionalHeadTags
+        [ link
+              [ _rel "stylesheet"
+                _href "https://cdn.jsdelivr.net/npm/bulma@0.9.2/css/bulma.min.css" ] ]
     |> Chart.withDescription description3
 
 (**
@@ -150,13 +135,11 @@ It will add a MathJax script reference to your document based on which version (
 *)
 
 let mathtex_chart =
-    [
-        Chart.Point(xy = [(1.,2.)],Name = @"$\beta_{1c} = 25 \pm 11 \text{ km s}^{-1}$")
-        Chart.Point(xy = [(2.,4.)],Name = @"$\beta_{1c} = 25 \pm 11 \text{ km s}^{-1}$")
-    ]
+    [ Chart.Point(xy = [ (1., 2.) ], Name = @"$\beta_{1c} = 25 \pm 11 \text{ km s}^{-1}$")
+      Chart.Point(xy = [ (2., 4.) ], Name = @"$\beta_{1c} = 25 \pm 11 \text{ km s}^{-1}$") ]
     |> Chart.combine
     |> Chart.withTitle @"$\beta_{1c} = 25 \pm 11 \text{ km s}^{-1}$"
-    |> Chart.withMathTex(AppendTags = true, MathJaxVersion = 3)
+    |> Chart.withMathTex (AppendTags = true, MathJaxVersion = 3)
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -166,4 +149,3 @@ mathtex_chart
 (***hide***)
 mathtex_chart |> GenericChart.toChartHTML
 (***include-it-raw***)
-

docs/00_3_chart-config.fsx

@@ -15,7 +15,8 @@ index: 4
 #r "nuget: Giraffe.ViewEngine, 1.4.0"
 #r "../src/Plotly.NET/bin/Release/netstandard2.0/Plotly.NET.dll"
 
-Plotly.NET.Defaults.DefaultDisplayOptions <- Plotly.NET.DisplayOptions.init(PlotlyJSReference = Plotly.NET.PlotlyJSReference.NoReference)
+Plotly.NET.Defaults.DefaultDisplayOptions <-
+    Plotly.NET.DisplayOptions.init (PlotlyJSReference = Plotly.NET.PlotlyJSReference.NoReference)
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -52,18 +53,17 @@ open Plotly.NET.ConfigObjects
 
 let svgConfig =
     Config.init (
-        ToImageButtonOptions = ToImageButtonOptions.init(
-            Format = StyleParam.ImageFormat.JPEG,
-            Filename = "mySvgChart",
-            Width = 900.,
-            Height = 600.,
-            Scale = 10.
-        )
+        ToImageButtonOptions =
+            ToImageButtonOptions.init (
+                Format = StyleParam.ImageFormat.JPEG,
+                Filename = "mySvgChart",
+                Width = 900.,
+                Height = 600.,
+                Scale = 10.
+            )
     )
 
-let svgButtonChart = 
-    Chart.Point(xy = [(1.,2.)])
-    |> Chart.withConfig svgConfig
+let svgButtonChart = Chart.Point(xy = [ (1., 2.) ]) |> Chart.withConfig svgConfig
 
 
 (*** condition: ipynb ***)
@@ -82,11 +82,9 @@ To create a static plot that has no hoverable elements, use `StaticPlot=true` on
 
 *)
 
-let staticConfig = Config.init(StaticPlot=true)
+let staticConfig = Config.init (StaticPlot = true)
 
-let staticPlot =
-    Chart.Point(xy = [(1.,2.)])
-    |> Chart.withConfig staticConfig
+let staticPlot = Chart.Point(xy = [ (1., 2.) ]) |> Chart.withConfig staticConfig
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -104,19 +102,10 @@ You can define fields that can be edited on the chart by setting `Editable = tru
 
 *)
 
-let editableConfig = 
-    Config.init(
-        Editable = true,
-        Edits = Edits.init(
-            LegendPosition  = true,
-            AxisTitleText   = true,
-            LegendText      = true
-        )
-    )
+let editableConfig =
+    Config.init (Editable = true, Edits = Edits.init (LegendPosition = true, AxisTitleText = true, LegendText = true))
 
-let editablePlot =
-    Chart.Point(xy = [(1.,2.)])
-    |> Chart.withConfig editableConfig
+let editablePlot = Chart.Point(xy = [ (1., 2.) ]) |> Chart.withConfig editableConfig
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -135,11 +124,10 @@ To create a chart that is reponsive to its container size, use `Responsive=true`
 (try resizing the window)
 *)
 
-let responsiveConfig = Config.init(Responsive=true)
+let responsiveConfig = Config.init (Responsive = true)
 
 let responsivePlot =
-    Chart.Point(xy = [(1.,2.)])
-    |> Chart.withConfig responsiveConfig
+    Chart.Point(xy = [ (1., 2.) ]) |> Chart.withConfig responsiveConfig
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -148,4 +136,4 @@ responsivePlot
 
 (***hide***)
 responsivePlot |> GenericChart.toChartHTML
-(***include-it-raw***)
+(***include-it-raw***)

docs/00_4_templates.fsx

@@ -15,7 +15,8 @@ index: 5
 #r "nuget: Giraffe.ViewEngine, 1.4.0"
 #r "../src/Plotly.NET/bin/Release/netstandard2.0/Plotly.NET.dll"
 
-Plotly.NET.Defaults.DefaultDisplayOptions <- Plotly.NET.DisplayOptions.init(PlotlyJSReference = Plotly.NET.PlotlyJSReference.NoReference)
+Plotly.NET.Defaults.DefaultDisplayOptions <-
+    Plotly.NET.DisplayOptions.init (PlotlyJSReference = Plotly.NET.PlotlyJSReference.NoReference)
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -35,9 +36,8 @@ premade templates can be accessed via the `ChartTemplates` module. In fact, the
 *)
 open Plotly.NET
 
-let lightMirrored = 
-    Chart.Point(xy = [1,2])
-    |> Chart.withTemplate ChartTemplates.lightMirrored
+let lightMirrored =
+    Chart.Point(xy = [ 1, 2 ]) |> Chart.withTemplate ChartTemplates.lightMirrored
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -59,25 +59,18 @@ Chart Templates consist of a `Layout` object and a collection of `Trace` objects
 
 open Plotly.NET.TraceObjects
 
-let layoutTemplate = 
-    Layout.init(
-        Title = Title.init("I will always be there now!")
-    )
+let layoutTemplate =
+    Layout.init (Title = Title.init ("I will always be there now!"))
 
-let traceTemplates = 
-    [
-        Trace2D.initScatter(
-            Trace2DStyle.Scatter(
-                Marker = Marker.init(Symbol = StyleParam.MarkerSymbol.ArrowLeft, Size = 20)
-            )
-        )
-    ]
+let traceTemplates =
+    [ Trace2D.initScatter (
+          Trace2DStyle.Scatter(Marker = Marker.init (Symbol = StyleParam.MarkerSymbol.ArrowLeft, Size = 20))
+      ) ]
 
-let myTemplate = Template.init(layoutTemplate, traceTemplates)
+let myTemplate = Template.init (layoutTemplate, traceTemplates)
 
 let myTemplateExampleChart =
-    Chart.Point(xy = [1,2])
-    |> Chart.withTemplate myTemplate
+    Chart.Point(xy = [ 1, 2 ]) |> Chart.withTemplate myTemplate
 
 (*** condition: ipynb ***)
 #if IPYNB