Skip to content

Add typos for source code spelling check#4690

Merged
seisman merged 4 commits into
mainfrom
tool/typos
Jun 24, 2026
Merged

Add typos for source code spelling check#4690
seisman merged 4 commits into
mainfrom
tool/typos

Conversation

@seisman

@seisman seisman commented Jun 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Closes #4689.

Changes in this PR:

  • Add support for typos
  • Ignore some words for typos
  • Rename the codespell make target to the more general target spellcheck
  • Update the instruction in the release checklist

After excluding some false detections, typos still reports one typo:

error: `pricipal` should be `principal`
    ╭▸ ./doc/changes.md:643:25
    │
643 │ * Figure.meca: Fix typo pricipal_axis -> principal_axis ([#2940](https://github.com/GenericMa…
    ╰╴                        ━━━━━━━━
make: *** [Makefile:71: spellcheck] Error 1

I guess we need to either remove the entry from the changelog or just ignore it.

Preview:

@seisman seisman added this to the 0.19.0 milestone Jun 21, 2026
@seisman seisman added maintenance Boring but important stuff for the core devs needs review This PR has higher priority and needs review. labels Jun 21, 2026
@seisman seisman marked this pull request as draft June 21, 2026 13:47
@seisman seisman changed the title Add typos for source code spelling check WIP: Add typos for source code spelling check Jun 21, 2026
yvonnefroehlich
yvonnefroehlich reviewed Jun 23, 2026
View reviewed changes
Comment thread pyproject.toml Outdated
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Jun 24, 2026
@seisman seisman changed the title WIP: Add typos for source code spelling check Add typos for source code spelling check Jun 24, 2026
@seisman seisman marked this pull request as ready for review June 24, 2026 03:40
@seisman seisman requested a review from yvonnefroehlich June 24, 2026 03:40
@seisman

seisman commented Jun 24, 2026

Copy link
Copy Markdown
Member Author

I've refactored this PR after #4691, please give this PR another round of review.

yvonnefroehlich
yvonnefroehlich reviewed Jun 24, 2026
View reviewed changes
Comment thread pygmt/src/velo.py Outdated
@seisman @yvonnefroehlich
Update pygmt/src/velo.py
cc15882 
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman seisman merged commit 4172333 into main Jun 24, 2026
22 checks passed
@seisman seisman deleted the tool/typos branch June 24, 2026 12:12
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jun 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yvonnefroehlich yvonnefroehlich yvonnefroehlich approved these changes

Assignees

No one assigned

Labels

maintenance Boring but important stuff for the core devs

Projects

None yet

Milestone

0.19.0

Development

Successfully merging this pull request may close these issues.

Use typos for spell checking

2 participants

@seisman @yvonnefroehlich