spellcheck CI (#26)

* spellcheck CI

* spellcheck

* fix docs build

.github/workflows/spellcheck.yml

@@ -0,0 +1,23 @@
+# adapted from https://github.com/JuliaDocs/Documenter.jl/blob/master/.github/workflows/SpellCheck.yml
+# see docs at https://github.com/crate-ci/typos
+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@v4
+      - name: Check spelling
+        uses: crate-ci/typos@master
+        # don't fail on typos in files not impacted by this PR
+        continue-on-error: true
+        with:
+            config: _typos.toml
+            write_changes: true
+      - uses: reviewdog/action-suggester@v1
+        with:
+          tool_name: Typos
+          fail_on_error: true

_typos.toml

@@ -0,0 +1,20 @@
+# https://github.com/crate-ci/typos#false-positives
+[default]
+
+[default.extend-identifiers]
+Lik = "Lik"
+missings = "missings"
+
+[default.extend-words]
+Lik = "Lik"
+missings = "missings"
+
+[type.package_toml]
+# Don't check spellings in these files
+extend-glob = ["Manifest.toml", "Project.toml"]
+check-file = false
+
+[type.bib]
+# contain lots of names, which are a great spot for false positives
+extend-glob = ["*.bib"]
+check-file = false

docs/Project.toml

@@ -1,3 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 MixedModelsExtras = "781a26e1-49f4-409a-8f4c-c3159d78c17e"
+
+[compat]
+Documenter = "1"

docs/make.jl

@@ -1,9 +1,12 @@
 using Documenter
 using MixedModelsExtras
 
-makedocs(; root=joinpath(dirname(pathof(MixedModelsExtras)), "..", "docs"),
+makedocs(;
+         repo=Remotes.GitHub("palday", "MixedModelsExtras.jl"),
          sitename="MixedModelsExtras",
          doctest=true,
+         checkdocs=:exports,
+         warnonly=[:cross_references],
          pages=["index.md", "api.md"])
 
 deploydocs(; repo="github.com/palday/MixedModelsExtras.jl.git", push_preview=true)

src/remef.jl

@@ -23,7 +23,7 @@ The default is to match the specified fixed effects for all grouping variables,
 but note that this will fail when the fixed effects specification is incompatible
 with any grouping variable.
 
-The keyword arugment `mode` specifies whether the fixed and random effects
+The keyword argument `mode` specifies whether the fixed and random effects
 specifications are treated as coefficients to `:include` or `:exclude`.
 
 !!! note