Skip to content

Add Workflow For Spell-Checking - #87

Open
O957 wants to merge 2 commits into
J535D165:mainfrom
O957:o957_add_workflow_for_spell_checking
Open

O957 wants to merge 2 commits into
J535D165:mainfrom
O957:o957_add_workflow_for_spell_checking

Conversation

@O957

@O957 O957 commented Oct 26, 2025 •

Copy link
Copy Markdown

This PR:

  • Fixes spelling errors (only 1) found across pyalex.
  • Adds a workflow called fix-typos.yaml to ./.github/workflows that runs in pulls requests and checks for common spelling mistakes.
  • Adds the hook for typos in the .pre-commit-config.yaml file.
  • Adds a configuration file (_typos.yaml), which can be used for false positives, for the typos workflow.

If interested in this PR, please choose between the pre-commit hook and the workflow.

Example Error Found Using Typos In Pre-Commit (Locally) Screenshot 2025-10-26 at 11 19 40

One can use _typos.toml to indicate false positives (this doesn't seem to be needed in pyalex right now, but it's good to have). For example,

Example Typos Configuration File Screenshot 2025-09-15 at 15 09 33

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.

1 participant