From c2ff77852d4f7dcce1e38b0deba65ece19a2da6d Mon Sep 17 00:00:00 2001 From: Hendrik Ranocha Date: Sat, 7 Oct 2023 06:14:45 +0200 Subject: [PATCH 1/3] Create SpellCheck CI job --- .github/workflows/SpellCheck.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/workflows/SpellCheck.yml diff --git a/.github/workflows/SpellCheck.yml b/.github/workflows/SpellCheck.yml new file mode 100644 index 0000000..eae6d8e --- /dev/null +++ b/.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@v4 + - name: Check spelling + uses: crate-ci/typos@v1.16.15 From 2000acc148962493dc6491bfd86f03f8096a1c67 Mon Sep 17 00:00:00 2001 From: Hendrik Ranocha Date: Sat, 7 Oct 2023 06:19:48 +0200 Subject: [PATCH 2/3] fix typo and ignore wrapper --- .typos.toml | 4 ++++ docs/src/introduction.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 .typos.toml diff --git a/.typos.toml b/.typos.toml new file mode 100644 index 0000000..2aa8e62 --- /dev/null +++ b/.typos.toml @@ -0,0 +1,4 @@ + +[files] +# ignore possible typos in the wrappers generated automatically +extend-exclude = ["src/LibP4est.jl"] diff --git a/docs/src/introduction.md b/docs/src/introduction.md index ad530a3..7f91220 100644 --- a/docs/src/introduction.md +++ b/docs/src/introduction.md @@ -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() From 48260422f79c9997ea8f3dc109c39da3251d3f96 Mon Sep 17 00:00:00 2001 From: Hendrik Ranocha Date: Sat, 7 Oct 2023 06:21:45 +0200 Subject: [PATCH 3/3] fix typos --- dev/generator.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dev/generator.toml b/dev/generator.toml index d78ce7e..86dfcbd 100644 --- a/dev/generator.toml +++ b/dev/generator.toml @@ -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" @@ -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