From cb4f31fc4f701cd69800885688ff12777db36cf4 Mon Sep 17 00:00:00 2001 From: David Nevado Date: Tue, 30 Apr 2024 12:21:07 +0200 Subject: [PATCH] Add spellcheck CI (#4) * add: spellcheck CI * fix: spell-check allow advices --- .config/typos.toml | 2 ++ .github/workflows/lints.yml | 7 +++++-- src/lib.rs | 4 ++-- 3 files changed, 9 insertions(+), 4 deletions(-) create mode 100644 .config/typos.toml diff --git a/.config/typos.toml b/.config/typos.toml new file mode 100644 index 0000000..f78af39 --- /dev/null +++ b/.config/typos.toml @@ -0,0 +1,2 @@ +[default.extend-words] +advices = "advices" diff --git a/.github/workflows/lints.yml b/.github/workflows/lints.yml index 980f4e8..e739225 100644 --- a/.github/workflows/lints.yml +++ b/.github/workflows/lints.yml @@ -30,7 +30,6 @@ jobs: name: Various lints timeout-minutes: 30 runs-on: ubuntu-latest - steps: - uses: actions/checkout@v2 - uses: actions-rs/toolchain@v1 @@ -62,6 +61,10 @@ jobs: with: command: clippy args: --all-features --all-targets -- -D warnings + - name: Use typos with config file + uses: crate-ci/typos@master + with: + config: .config/typos.toml # Ensure intra-documentation links all resolve correctly # Requires #![deny(intra_doc_link_resolution_failure)] in crates. @@ -69,4 +72,4 @@ jobs: uses: actions-rs/cargo@v1 with: command: doc - args: --no-deps --all --document-private-items \ No newline at end of file + args: --no-deps --all --document-private-items diff --git a/src/lib.rs b/src/lib.rs index 507d566..19d18b5 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,6 +1,6 @@ //! This crate provides the poseidon gadget for use with `halo2_proofs`. -//! This gadget has been stracted from zcash's halo2_gadgets: -//! +//! This gadget has been extracted from zcash's halo2_gadgets: +//! https://github.com/zcash/halo2/tree/main/halo2_gadgets #![cfg_attr(docsrs, feature(doc_cfg))] // Catch documentation errors caused by code changes.