Naming fixes

.github/workflows/verify-docs.yml

@@ -0,0 +1,25 @@
+name: Verify docs
+
+on:
+  push:
+    branches: [ dev ]
+  pull_request:
+    branches: [ dev ]
+
+jobs:
+  verify-docs:
+
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup .NET 5
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '5.0.302'
+
+    - name: Run verification script
+      run: |
+        dotnet tool restore
+        dotnet fake build -t verifydocs

build.fsx

@@ -15,6 +15,8 @@ nuget Fake.Api.Github
 nuget Fake.DotNet.Testing.Expecto 
 nuget Fake.Tools.Git //"
 
+#r "FSharp.Compiler.Service.dll"
+
 #if !FAKE
 #load "./.fake/build.fsx/intellisense.fsx"
 #r "netstandard" // Temp fix for https://github.com/dotnet/fsharp/issues/5216
@@ -168,6 +170,44 @@ module TestTasks =
         ) testProject
     }
 
+
+module VerificationTasks =
+    open FSharp.Compiler.Diagnostics
+    open BasicTasks
+
+    let verifyDocs = BuildTask.create "VerifyDocs" [clean; build; copyBinaries] {
+        let targets = !! "docs/**.fsx" |> Seq.map (fun f -> f.ToString())
+
+        let checker = FSharp.Compiler.CodeAnalysis.FSharpChecker.Create ()
+
+        let ignoredDiagnostics = Set.ofList [ 
+            1182; // unused variable
+            ]
+
+        targets
+        |> Seq.map (
+            fun target -> 
+            checker.Compile ( [| "fsc.exe"; "-o"; @"aaaaaaaaaaa.exe"; "-a"; target |] )
+            |> Async.RunSynchronously
+            |> fst
+            |> Seq.where (fun diag -> match diag.Severity with FSharpDiagnosticSeverity.Error | FSharpDiagnosticSeverity.Warning -> true | _ -> false)
+        )
+        |> Seq.collect id
+        |> Seq.where (fun c -> not (ignoredDiagnostics.Contains c.ErrorNumber))
+        |> Seq.sortBy (fun diag -> (match diag.Severity with FSharpDiagnosticSeverity.Error -> 0 | _ -> 1), diag.FileName.[..6] (* to only count the numeric part *) )
+        |> Seq.map (fun diag -> 
+            (match diag.Severity with
+            | FSharpDiagnosticSeverity.Error -> "--- Error: "
+            | _ -> "--- Warning: ")
+            + diag.ToString())
+        |> String.concat "\n"
+        |> (fun errorText ->
+            match errorText with
+            | "" -> ()
+            | text -> raise (System.Exception $"Errors:\n{text}" )
+            )
+    }
+
 /// Package creation
 module PackageTasks = 
 
@@ -404,4 +444,4 @@ let _preReleaseNoDocs =
         [setPrereleaseTag; clean; build; copyBinaries; runTests; packPrerelease; createPrereleaseTag; publishNugetPrerelease]
 
 // run copyBinaries by default
-BuildTask.runOrDefault copyBinaries
+BuildTask.runOrDefault copyBinaries

docs/0_0_basics.fsx

@@ -47,6 +47,7 @@ The central type that gets created by all Chart constructors is `GenericChart`,
 *)
 
 (***do-not-eval***)
+[<NoComparison>]
 type GenericChart =
     | Chart of Trace * Layout * Config * DisplayOptions
     | MultiChart of Trace list * Layout * Config * DisplayOptions
@@ -75,7 +76,7 @@ myTrace?x <- [0;1;2] // set the x property (the x dimension of the data)
 myTrace?y <- [0;1;2] // set the y property (the y dimension of the data)
 
 GenericChart.ofTraceObject myTrace // create a generic chart (layout and config are empty objects)
-|> Chart.Show
+|> Chart.show
 
 (**
 lets have a look at the trace object that will be created. The relevant section of the html generated with Chart.Show is the following:

docs/0_2_display-options.fsx

@@ -55,8 +55,8 @@ let description1 =
 (***do-not-eval***)
 let desc1 =
     Chart.Point(x,y,Name="desc1")    
-    |> Chart.WithDescription(description1)
-    |> Chart.Show
+    |> Chart.withDescription(description1)
+    |> Chart.show
 
 (**
 
@@ -71,8 +71,8 @@ let description2 =
 (***do-not-eval***)
 let desc2 =
     Chart.Point(x,y,Name="desc1")    
-    |> Chart.WithDescription(description2)
-    |> Chart.Show
+    |> Chart.withDescription(description2)
+    |> Chart.show
 
 (**
 
@@ -108,10 +108,10 @@ let description3 =
 (***do-not-eval***)
 let desc3 =
     Chart.Point(x,y,Name="desc3")    
-    |> Chart.WithDescription description3
+    |> Chart.withDescription description3
     // Add reference to the bulma css framework
-    |> Chart.WithAdditionalHeadTags ["""<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.2/css/bulma.min.css">"""]
-    |> Chart.Show
+    |> Chart.withAdditionalHeadTags ["""<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.2/css/bulma.min.css">"""]
+    |> Chart.show
 
 (**
 
@@ -128,11 +128,11 @@ By popular request, `Chart.WithMathTex` is a prebuilt function to enable MathTeX
     Chart.Point([(1.,2.)],@"$\beta_{1c} = 25 \pm 11 \text{ km s}^{-1}$")
     Chart.Point([(2.,4.)],@"$\beta_{1c} = 25 \pm 11 \text{ km s}^{-1}$")
 ]
-|> Chart.Combine
+|> Chart.combine
 |> Chart.withTitle @"$\beta_{1c} = 25 \pm 11 \text{ km s}^{-1}$"
 // include mathtex tags in <head>. pass true to append these scripts, false to ONLY include MathTeX.
-|> Chart.WithMathTex(true)
-|> Chart.Show
+|> Chart.withMathTex(true)
+|> Chart.show
 
 (**
 

docs/1_0_axis-styling.fsx

@@ -45,8 +45,8 @@ To style a specific axis of a plot, use the respective `Chart.with*_AxisStyle` f
 
 let plot1 =
     Chart.Point(x,y)
-    |> Chart.withX_AxisStyle ("X axis title", MinMax = (-1.,10.))
-    |> Chart.withY_AxisStyle ("Y axis title", MinMax = (-1.,10.))
+    |> Chart.withXAxisStyle ("X axis title", MinMax = (-1.,10.))
+    |> Chart.withYAxisStyle ("Y axis title", MinMax = (-1.,10.))
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -83,8 +83,8 @@ let mirroredLogYAxis =
 
 let plot2 =
     Chart.Point(x,y)
-    |> Chart.withX_Axis mirroredXAxis
-    |> Chart.withY_Axis mirroredLogYAxis
+    |> Chart.withXAxis mirroredXAxis
+    |> Chart.withYAxis mirroredLogYAxis
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -122,13 +122,13 @@ let twoXAxes1 =
        anchoredAt1
        anchoredAt2
     ]
-    |> Chart.Combine
-    |> Chart.withY_AxisStyle(
+    |> Chart.combine
+    |> Chart.withYAxisStyle(
         "axis 1",
         Side=StyleParam.Side.Left,
         Id=1
     )
-    |> Chart.withY_AxisStyle(
+    |> Chart.withYAxisStyle(
         "axis2",
         Side=StyleParam.Side.Right,
         Id=2,
@@ -156,16 +156,16 @@ let twoXAxes2 =
         anchoredAt1
         anchoredAt2
     ]
-    |> Chart.Combine
-    |> Chart.withY_AxisStyle(
+    |> Chart.combine
+    |> Chart.withYAxisStyle(
             "first y-axis",
             ShowLine=true
             )
-    |> Chart.withX_AxisStyle(
+    |> Chart.withXAxisStyle(
         "x-axis",
         Domain=(0.3, 1.0) // moves the first axis and the whole plot to the right
     ) 
-    |> Chart.withY_AxisStyle(
+    |> Chart.withYAxisStyle(
         "second y-axis",
         Side=StyleParam.Side.Left,
         Id=2,

docs/1_2_multiple-charts.fsx

@@ -52,7 +52,7 @@ let combinedChart =
         Chart.Line(x,y,Name="first")
         Chart.Line(y,x,Name="second")
     ]
-    |> Chart.Combine
+    |> Chart.combine
 
 #if IPYNB
 combinedChart
@@ -77,17 +77,17 @@ You can either use Chart.Grid with a 1 dimensional sequence of Charts and specif
 let grid = 
     [
         Chart.Point(x,y,Name="1,1")
-        |> Chart.withX_AxisStyle "x1"
-        |> Chart.withY_AxisStyle "y1"    
+        |> Chart.withXAxisStyle "x1"
+        |> Chart.withYAxisStyle "y1"    
         Chart.Line(x,y,Name="1,2")
-        |> Chart.withX_AxisStyle "x2"
-        |> Chart.withY_AxisStyle "y2"
+        |> Chart.withXAxisStyle "x2"
+        |> Chart.withYAxisStyle "y2"
         Chart.Spline(x,y,Name="2,1")
-        |> Chart.withX_AxisStyle "x3"
-        |> Chart.withY_AxisStyle "y3"    
+        |> Chart.withXAxisStyle "x3"
+        |> Chart.withYAxisStyle "y3"    
         Chart.Point(x,y,Name="2,2")
-        |> Chart.withX_AxisStyle "x4"
-        |> Chart.withY_AxisStyle "y4"
+        |> Chart.withXAxisStyle "x4"
+        |> Chart.withYAxisStyle "y4"
     ]
     |> Chart.Grid(2,2)
 
@@ -109,19 +109,19 @@ let grid2 =
     [
         [
             Chart.Point(x,y,Name="1,1")
-            |> Chart.withX_AxisStyle "x1"
-            |> Chart.withY_AxisStyle "y1"    
+            |> Chart.withXAxisStyle "x1"
+            |> Chart.withYAxisStyle "y1"    
             Chart.Line(x,y,Name="1,2")
-            |> Chart.withX_AxisStyle "x2"
-            |> Chart.withY_AxisStyle "y2"
+            |> Chart.withXAxisStyle "x2"
+            |> Chart.withYAxisStyle "y2"
         ]
         [
             Chart.Spline(x,y,Name="2,1")
-            |> Chart.withX_AxisStyle "x3"
-            |> Chart.withY_AxisStyle "y3"    
+            |> Chart.withXAxisStyle "x3"
+            |> Chart.withYAxisStyle "y3"    
             Chart.Point(x,y,Name="2,2")
-            |> Chart.withX_AxisStyle "x4"
-            |> Chart.withY_AxisStyle "y4"
+            |> Chart.withXAxisStyle "x4"
+            |> Chart.withYAxisStyle "y4"
 
         ]
     ]
@@ -146,18 +146,18 @@ to the row with the highest amount of charts, and the other rows will be filled
 let grid3 = 
     [
         Chart.Point(x,y,Name="1,1")
-        |> Chart.withX_AxisStyle "x1"
-        |> Chart.withY_AxisStyle "y1"    
+        |> Chart.withXAxisStyle "x1"
+        |> Chart.withYAxisStyle "y1"    
 
         Chart.Invisible()
 
         Chart.Spline(x,y,Name="2,1")
-        |> Chart.withX_AxisStyle "x3"
-        |> Chart.withY_AxisStyle "y3"    
+        |> Chart.withXAxisStyle "x3"
+        |> Chart.withYAxisStyle "y3"    
 
         Chart.Point(x,y,Name="2,2")
-        |> Chart.withX_AxisStyle "x4"
-        |> Chart.withY_AxisStyle "y4"
+        |> Chart.withXAxisStyle "x4"
+        |> Chart.withYAxisStyle "y4"
     ]
     |> Chart.Grid(2,2)
 
@@ -178,17 +178,17 @@ use `Pattern=StyleParam.LayoutGridPatter.Coupled` to use one shared x axis per c
 let grid4 =
     [
         Chart.Point(x,y,Name="1,1")
-        |> Chart.withX_AxisStyle "x1"
-        |> Chart.withY_AxisStyle "y1"    
+        |> Chart.withXAxisStyle "x1"
+        |> Chart.withYAxisStyle "y1"    
         Chart.Line(x,y,Name="1,2")
-        |> Chart.withX_AxisStyle "x2"
-        |> Chart.withY_AxisStyle "y2"
+        |> Chart.withXAxisStyle "x2"
+        |> Chart.withYAxisStyle "y2"
         Chart.Spline(x,y,Name="2,1")
-        |> Chart.withX_AxisStyle "x3"
-        |> Chart.withY_AxisStyle "y3"    
+        |> Chart.withXAxisStyle "x3"
+        |> Chart.withYAxisStyle "y3"    
         Chart.Point(x,y,Name="2,2")
-        |> Chart.withX_AxisStyle "x4"
-        |> Chart.withY_AxisStyle "y4"
+        |> Chart.withXAxisStyle "x4"
+        |> Chart.withYAxisStyle "y4"
     ]
     |> Chart.Grid(2,2,Pattern=StyleParam.LayoutGridPattern.Coupled)
 
@@ -214,19 +214,19 @@ As with all grid charts, you can also use the Chart.withLayoutGridStyle to style
 let singleStack =
     [
         Chart.Point(x,y) 
-        |> Chart.withY_AxisStyle("This title must")
+        |> Chart.withYAxisStyle("This title must")
 
         Chart.Line(x,y) 
-        |> Chart.withY_AxisStyle("be set on the")
+        |> Chart.withYAxisStyle("be set on the")
 
         Chart.Spline(x,y) 
-        |> Chart.withY_AxisStyle("respective subplots")
+        |> Chart.withYAxisStyle("respective subplots")
     ]
     |> Chart.SingleStack(Pattern= StyleParam.LayoutGridPattern.Coupled)
     //increase spacing between plots by using the withLayoutGridStyle function
     |> Chart.withLayoutGridStyle(YGap= 0.1)
     |> Chart.withTitle("Hi i am the new SingleStackChart")
-    |> Chart.withX_AxisStyle("im the shared xAxis")
+    |> Chart.withXAxisStyle("im the shared xAxis")
 
 (*** condition: ipynb ***)
 #if IPYNB

docs/2_1_bar-and-column-charts.fsx

@@ -84,7 +84,7 @@ let stackedBar =
         Chart.StackedBar(keys,values,Name="old");
         Chart.StackedBar(keys,[8; 21; 13;],Name="new")
     ]
-    |> Chart.Combine
+    |> Chart.combine
 
 (*** condition: ipynb ***)
 #if IPYNB
@@ -104,7 +104,7 @@ let stackedColumn =
         Chart.StackedColumn(keys,values,Name="old");
         Chart.StackedColumn(keys,[8; 21; 13;],Name="new")
     ]
-    |> Chart.Combine
+    |> Chart.combine
 
 (*** condition: ipynb ***)
 #if IPYNB

docs/2_2_area-plots.fsx

@@ -80,7 +80,7 @@ let stackedArea =
         Chart.StackedArea(x,y)
         Chart.StackedArea(x,y |> Seq.rev)
     ]
-    |> Chart.Combine
+    |> Chart.combine
 
 (*** condition: ipynb ***)
 #if IPYNB

docs/3_0_3d-scatter-plots.fsx

@@ -40,9 +40,9 @@ let z = [19; 26; 55;]
 
 let scatter3d = 
     Chart.Scatter3d(x,y,z,StyleParam.Mode.Markers)
-    |> Chart.withX_AxisStyle("my x-axis")
-    |> Chart.withY_AxisStyle("my y-axis")
-    |> Chart.withZ_AxisStyle("my z-axis")
+    |> Chart.withXAxisStyle("my x-axis")
+    |> Chart.withYAxisStyle("my y-axis")
+    |> Chart.withZAxisStyle("my z-axis")
     |> Chart.withSize(800.,800.)
 
 (*** condition: ipynb ***)