Skip to content

Commit

Permalink
Add spellcheck CI (#4)
Browse files Browse the repository at this point in the history
* add: spellcheck CI

* fix: spell-check allow advices
  • Loading branch information
davidnevadoc authored Apr 30, 2024
1 parent 764a682 commit cb4f31f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .config/typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[default.extend-words]
advices = "advices"
7 changes: 5 additions & 2 deletions .github/workflows/lints.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -62,11 +61,15 @@ 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.
- name: Check intra-doc links
uses: actions-rs/cargo@v1
with:
command: doc
args: --no-deps --all --document-private-items
args: --no-deps --all --document-private-items
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -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:
//! <https://github.com/zcash/halo2/tree/main/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.
Expand Down

0 comments on commit cb4f31f

Please sign in to comment.