Skip to content

[CI Issue] Spell Check consistently failing on false positives in SVG file #1120

@ChrisRackauckas-Claude

Description

@ChrisRackauckas-Claude

Summary

The Spell Check CI job is consistently failing on all PRs due to false positives in an auto-generated SVG file.

Which CI job failed

Spell Check with Typos - Fails in ~7 seconds on every PR

Error Details

The spell checker (crate-ci/typos) is flagging the identifier daa in ./assets/DifferentialEquations_Example.svg as a typo (suggesting it should be "data"). However, this is not a typo - it's part of auto-generated SVG element IDs like m2daa2affb1.

Affected locations in SVG: Lines 50, 53, 97, 146, 185, 209, 4101, 4126, 4151, 4176

Example from the SVG:
```xml




```

Root Cause

The spell check workflow (.github/workflows/SpellCheck.yml) uses crate-ci/typos@v1.18.0 which doesn't exclude binary/generated files by default. The .typos.toml configuration doesn't currently exclude SVG files or whitelist the daa identifier pattern.

Recent History

Suggested Fix

Add to .typos.toml:

```toml
[files]
extend-exclude = [".svg", ".png"]
```

OR add the false positive to the dictionary:

```toml
[default.extend-words]
daa = "daa"
```

The first option (excluding SVG files) is cleaner since SVG files are typically auto-generated and shouldn't need spell checking.

Related Links

cc @ChrisRackauckas

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions