Skip to content

Add comprehensive spell checking configuration #657

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

Merged
merged 2 commits into from
Jul 29, 2025

Conversation

ChrisRackauckas
Copy link
Member

Summary

This PR adds comprehensive spell checking configuration to standardize spell checking across the SciML ecosystem.

Changes

  • ****: Comprehensive configuration file with extensive Julia/SciML-specific terminology allowances including:

    • Julia-specific functions (, , , , , etc.)
    • Mathematical/scientific terms (, , , , etc.)
    • Common variable patterns (, , , , , , etc.)
    • Common abbreviations (, , , , , , etc.)
    • Algorithm/type suffixes (, , , , , etc.)
    • Scientific abbreviations (, , , , etc.)
  • ****: GitHub Actions workflow for automated spell checking on pull requests using the tool

Benefits

  • Standardizes spell checking configuration across all SciML repositories
  • Prevents common typos while allowing extensive domain-specific terminology
  • Provides automated feedback on pull requests
  • Maintains consistency with Julia and scientific computing conventions
  • Reduces false positives with comprehensive allowance list

Testing

The configuration has been tested across the SciML ecosystem and includes comprehensive allowances for legitimate Julia/SciML terminology while catching actual typos.

- Add .typos.toml with extensive Julia/SciML-specific terminology allowances
- Add SpellCheck.yml GitHub Actions workflow for automated spell checking
- Includes allowances for Julia functions, mathematical terms, variable patterns, and scientific abbreviations
- Standardizes spell checking across SciML ecosystem
@ChrisRackauckas ChrisRackauckas merged commit 3793d95 into main Jul 29, 2025
36 of 39 checks passed
@ChrisRackauckas ChrisRackauckas deleted the add-comprehensive-spell-check branch July 29, 2025 13:38
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.

2 participants