Skip to content

Commit

Permalink
Create SpellCheck CI job (#89)
Browse files Browse the repository at this point in the history
* Create SpellCheck CI job

* fix typo and ignore wrapper

* fix typos
  • Loading branch information
ranocha authored Oct 12, 2023
1 parent 117dbd1 commit 1811e9b
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 3 deletions.
13 changes: 13 additions & 0 deletions .github/workflows/SpellCheck.yml
Original file line number Diff line number Diff line change
@@ -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@v4
- name: Check spelling
uses: crate-ci/[email protected]
4 changes: 4 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

[files]
# ignore possible typos in the wrappers generated automatically
extend-exclude = ["src/LibP4est.jl"]
4 changes: 2 additions & 2 deletions dev/generator.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ library_names = {}
# output file path relative to the working directory
output_file_path = "LibP4est.jl"

# if these are set, common file (types and constants) and API file (functions) will be seperated
# if these are set, common file (types and constants) and API file (functions) will be separated
# this is for compatibility, so prologue and epilogue are not supported.
# output_api_file_path = "api.jl"
# output_common_file_path = "common.jl"
Expand Down Expand Up @@ -190,7 +190,7 @@ print_enum_as_integer = false
use_deterministic_symbol = true

# by default, only those declarations in the local header file are processed.
# those declarations in the system headers will be treated sepcially and will be generated if necessary.
# those declarations in the system headers will be treated specially and will be generated if necessary.
# if you'd like to generate all of the symbols in the system headers, please set this option to false.
is_local_header_only = true

Expand Down
2 changes: 1 addition & 1 deletion docs/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ p4est_connectivity_destroy(connectivity)
p4est_destroy(p4est)
```

You may also use the `PonterWrapper` to set variables in `struct`s. Here we
You may also use the `PointerWrapper` to set variables in `struct`s. Here we
set the user data pointer in the `p4est_t` `struct` to point to some data:
```@repl
using P4est, MPI; MPI.Init()
Expand Down

0 comments on commit 1811e9b

Please sign in to comment.