add SpellCheck CI (trixi-framework#24)

* add SpellCheck CI

* fix typos caught by the CI

.github/workflows/SpellCheck.yml

@@ -0,0 +1,13 @@
+name: Spell Check
+
+on: [pull_request, workflow_dispatch]
+
+jobs:
+  typos-check:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v3
+      - name: Check spelling
+        uses: crate-ci/[email protected]

docs/src/github-git.md

@@ -95,7 +95,7 @@ review. That is, you should
     around)
   * remove debug statements
   * add a script `interactive_xxx.jl` that uses your feature (only relevant for new
-    features within the interactive mesh funtionality)
+    features within the interactive mesh functionality)
 
 After you are confident that your branch is cleaned up properly, commit all
 changes and push them to the repository.

examples/interactive_outer_boundary.jl

@@ -30,7 +30,7 @@ cone1    = newEndPointsLineCurve("cone1", [0.0, -3.0, 0.0], [1.0, 0.0, 0.0])
 iceCream = newCircularArcCurve("iceCream", [0.0, 0.0, 0.0], 1.0, 0.0, 180.0, "degrees")
 cone2    = newEndPointsLineCurve("cone2", [-1.0, 0.0, 0.0], [0.0, -3.0, 0.0])
 
-# Assemble the three curve in a closed chain oriented couter-clockwise. The chain
+# Assemble the three curve in a closed chain oriented counter-clockwise. The chain
 # name `IceCreamCone` is only used internally by HOHQMesh.
 
 addCurveToInnerBoundary!(p, cone1, "IceCreamCone")

examples/interactive_outer_boundary_generic.jl

@@ -34,7 +34,7 @@ cone1    = new("cone1", [0.0,-3.0,0.0], [1.0,0.0,0.0])
 iceCream = new("iceCream", [0.0,0.0,0.0], 1.0, 0.0, 180.0, "degrees")
 cone2    = new("cone2", [-1.0,0.0,0.0], [0.0,-3.0,0.0])
 
-# Assemble the three curve in a closed chain oriented couter-clockwise. The chain
+# Assemble the three curve in a closed chain oriented counter-clockwise. The chain
 # name `IceCreamCone` is only used internally by HOHQMesh.
 
 add!(p, cone1, "IceCreamCone")

examples/interactive_outer_box_two_circles.jl

@@ -20,7 +20,7 @@ p = newProject("box_two_circles", "out")
 setPolynomialOrder!(p, 4)
 setMeshFileFormat!(p, "ABAQUS")
 
-# Outer boundary for this example mesh wil be a rectangular box. For this the user
+# Outer boundary for this example mesh will be a rectangular box. For this the user
 # can set the lower left most point of the box, the spacing size in each coordinate
 # direction `[Δx, Δy, Δz]`, and the number of intervals taken.
 

src/Project/BackgroundGridAPI.jl

@@ -219,7 +219,7 @@ end
 """
     setBackgroundGridSize!(proj::Project, dx::Array{Float64}, key::String)
 
-Set the grid size dx of an existing background grid withing `proj`. Here, `dx`
+Set the grid size dx of an existing background grid within `proj`. Here, `dx`
 is passed an array.
 """
 function setBackgroundGridSize!(proj::Project, dx::Array{Float64}, key::String)

src/Project/Undo.jl

@@ -19,7 +19,7 @@ Note that these projects refer to the interactive mesh functionality projects,
 not Julia projects in the sense of `Project.toml`.
 To make the undo framework project based, undo() would be replaced by undo(project) and an .undoStack
 property of the project would replace HQMglobalUndoStack. This is
-not a big deal except if multiple projects are open, and muliple objects like curves have been
+not a big deal except if multiple projects are open, and multiple objects like curves have been
 defined but not added to a project. In interactive mode curves are separate from projects until
 added. (The same curve could be added to multiple projects.) So some logic needs to be
 figured out before modifying below. If only one project is managed per session,

src/Viz/VizProject.jl

@@ -14,7 +14,7 @@ just the mesh, `plotOptions = MESH`.
 
 To plot everything, `plotOptions = MODEL + GRID + MESH + REFINEMENTS`
 
-Contents are overlayed in the order: GRID, MESH, MODEL, REFINEMENTS
+Contents are overlaid in the order: GRID, MESH, MODEL, REFINEMENTS
 """
 function plotProject!(proj::Project, plotOptions::Int = 0)
 

test/test_background_grid.jl

@@ -53,7 +53,7 @@ using Test
     removeBackgroundGrid!(p)
     @test HOHQMesh.hasBackgroundGrid(p) == false
 #
-#   Add with method 3 (No outer bounday, preferred): bounding box + nPts
+#   Add with method 3 (No outer boundary, preferred): bounding box + nPts
 #
     addBackgroundGrid!(p, [10.0,-10.0,-5.0,5.0], [10,10,0])
     @test HOHQMesh.hasBackgroundGrid(p) == true

test/test_visualization.jl

@@ -133,7 +133,7 @@ using CairoMakie
     remove!(p_visu, "big_spline", "inner1")
     @test length(p_visu.innerBoundaryNames) == 2
 
-    # Do the rest of the inner boudary removals correctly.
+    # Do the rest of the inner boundary removals correctly.
     remove!(p_visu, "small_spline", "inner2")
     @test length(p_visu.innerBoundaryNames) == 1
     undo()