Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(codespell): Ignore some directories #8953

Merged
merged 1 commit into from
Oct 21, 2024
Merged

Conversation

oxarbitrage
Copy link
Contributor

Motivation

When codespell runs against the current main branch the following annotations will be displayed:

$ codespell --config .codespellrc 
./zebra-rpc/qa/rpc-tests/test_framework/script.py:20: bord ==> board, bored, border
./zebra-rpc/qa/rpc-tests/test_framework/script.py:24: bord ==> board, bored, border
./zebra-rpc/qa/rpc-tests/test_framework/script.py:709: bord ==> board, bored, border
./zebra-rpc/qa/rpc-tests/test_framework/script.py:725: bord ==> board, bored, border
./zebra-rpc/qa/rpc-tests/test_framework/script.py:732: bord ==> board, bored, border
./zebra-rpc/qa/rpc-tests/test_framework/script.py:732: bord ==> board, bored, border
./zebra-rpc/qa/rpc-tests/test_framework/script.py:739: bord ==> board, bored, border
./zebra-rpc/qa/rpc-tests/test_framework/script.py:739: bord ==> board, bored, border
./zebra-rpc/qa/rpc-tests/test_framework/script.py:739: bord ==> board, bored, border
./zebra-rpc/qa/rpc-tests/test_framework/script.py:739: bord ==> board, bored, border
./zebra-rpc/qa/rpc-tests/test_framework/zip244.py:280: nIn ==> inn, min, bin, nine
./zebra-rpc/qa/rpc-tests/test_framework/zip244.py:280: nIn ==> inn, min, bin, nine
./zebra-rpc/qa/rpc-tests/test_framework/zip244.py:282: nIn ==> inn, min, bin, nine
./zebra-rpc/qa/rpc-tests/test_framework/zip244.py:290: nIn ==> inn, min, bin, nine
./zebra-rpc/qa/rpc-tests/test_framework/zip244.py:293: nIn ==> inn, min, bin, nine
./supply-chain/imports.lock:645: ser ==> set
./supply-chain/imports.lock:654: ser ==> set
./supply-chain/imports.lock:656: ser ==> set
./supply-chain/imports.lock:713: neverthless ==> nevertheless
./supply-chain/imports.lock:1278: acces ==> access
./supply-chain/imports.lock:1584: soley ==> solely

Solution

As RPC tests are imported code, we want to ignore codespell there. Also ignore it in the supply-chain directory which is an automatic thing.

PR Author's Checklist

  • The PR name will make sense to users.
  • The PR provides a CHANGELOG summary.
  • The solution is tested.
  • The documentation is up to date.
  • The PR has a priority label.

PR Reviewer's Checklist

  • The PR Author's checklist is complete.
  • The PR resolves the issue.

@oxarbitrage oxarbitrage added C-cleanup Category: This is a cleanup P-Low ❄️ labels Oct 21, 2024
@oxarbitrage oxarbitrage requested a review from a team as a code owner October 21, 2024 12:53
@oxarbitrage oxarbitrage requested review from arya2 and removed request for a team October 21, 2024 12:53
@github-actions github-actions bot added the C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG label Oct 21, 2024
mergify bot added a commit that referenced this pull request Oct 21, 2024
@mergify mergify bot merged commit 01fa12b into main Oct 21, 2024
95 checks passed
@mergify mergify bot deleted the codespell-ignore-paths branch October 21, 2024 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-cleanup Category: This is a cleanup C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG P-Low ❄️
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants