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

chore: simplify spellcheck setup by combining wordlists #271

Merged

Conversation

danceratopz
Copy link
Member

This change combines the previous 3 wordlists into one file, so that it 'just works' with flake8 (without running an additional script).

The only disadvantages are that we will:

  1. Apply python specific words in whitelist.txt to the markdown spellcheck.
  2. Make it harder to keep track of types of words within the wordlist, e.g., opcodes. As adding a word via the VS Code cSpell interface reorders the dictionary alphabetically.

There aren't a big deal though.

The flake8-spellcheck plugin requires a file called whitelist.txt, this change combines the previous 3 wordlists into one file, so that it 'just works' with flake8. The only disadvantages are that we will:
1. Apply python specific words in whitelist.txt to the markdown spellcheck; not really a big deal.
2. Make it harder to keep track of types of words within the wordlist, e.g., opcodes. As adding a word via the VS Code Cspell interface reorders the dictionary alphabetically; also not such a big deal.
Copy link
Collaborator

@spencer-tb spencer-tb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for this :D

@danceratopz danceratopz merged commit ec18f1e into ethereum:main Aug 24, 2023
5 checks passed
@danceratopz danceratopz deleted the chore/simplify-spellcheck-setup branch September 28, 2023 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants