Merge pull request #203 from ArnoStrouwen/typos

typos CI
SciML · Dec 29, 2023 · b771463 · b771463
2 parents 2e2e239 + 201d9de
commit b771463
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 3 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,10 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    ignore:
+      - dependency-name: "crate-ci/typos"
+        update-types: ["version-update:semver-patch"]
diff --git a/.github/workflows/SpellCheck.yml b/.github/workflows/SpellCheck.yml
@@ -0,0 +1,13 @@
+name: Spell Check
+
+on: [pull_request]
+
+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] 
diff --git a/.typos.toml b/.typos.toml
@@ -0,0 +1,3 @@
+[default.extend-words]
+numer = "numer"
+MOR = "MOR"
diff --git a/docs/make_aggregate.jl b/docs/make_aggregate.jl
@@ -88,7 +88,7 @@ docsmodules = [
     ],
 ]
 
-fixnames = Dict("SciMLDocs" => "The SciML Open Souce Software Ecosystem",
+fixnames = Dict("SciMLDocs" => "The SciML Open Source Software Ecosystem",
                 "DiffEqDocs" => "DifferentialEquations",
                 "DiffEqDevDocs" => "DiffEq Developer Documentation",
                 "PlotDocs" => "Plots",

diff --git a/docs/src/highlevels/developer_documentation.md b/docs/src/highlevels/developer_documentation.md
@@ -67,7 +67,7 @@ JuliaFormatter check for SciML Style compliance on pull requests.
 To run JuliaFormatter in a SciML repository, do:
 
 ```julia
-using JuliaFomatter, DevedPackage
+using JuliaFormatter, DevedPackage
 JuliaFormatter.format(pkgdir(DevedPackage))
 ```
 

diff --git a/docs/src/showcase/blackhole.md b/docs/src/showcase/blackhole.md
@@ -282,7 +282,7 @@ function h_22_quadrupole_components(dt, orbit, component, mass=1.0)
         x(t) and y(t) inputs are the trajectory of the orbiting BH.
 
        WARNING: assuming x and y are on a uniform grid of spacing dt
-        x_index and y_index are 1,2,3 for x, y, and z indicies.
+        x_index and y_index are 1,2,3 for x, y, and z indices.
     =#
 
     mtensor = orbit2tensor(orbit, component, mass)