Skip to content

Fix typos and use codespell to prevent future typos - #5677

Merged
adamnovak merged 3 commits into
masterfrom
spelling
Nov 9, 2026
Merged

adamnovak merged 3 commits into
masterfrom
spelling

Conversation

@mr-c

@mr-c mr-c commented Nov 8, 2026

Copy link
Copy Markdown
Contributor
  • Fix spelling typos
  • use codespell to fix other trivial errors

Changelog Entry

To be copied to the draft changelog by merger:

  • Many typos fixed; codespell will now be used to prevent future typos

Reviewer Checklist

  • Make sure it is coming from issues/XXXX-fix-the-thing in the Toil repo, or from an external repo.
    • If it is coming from an external repo, make sure to pull it in for CI with:
      contrib/admin/test-pr otheruser theirbranchname issues/XXXX-fix-the-thing
      
    • If there is no associated issue, create one.
  • Read through the code changes. Make sure that it doesn't have:
    • Addition of trailing whitespace.
    • New variable or member names in camelCase that want to be in snake_case.
    • New functions without type hints.
    • New functions or classes without informative docstrings.
    • Changes to semantics not reflected in the relevant docstrings.
    • New or changed command line options for Toil workflows that are not reflected in docs/running/{cliOptions,cwl,wdl}.rst
    • New features without tests.
  • Comment on the lines of code where problems exist with a review comment. You can shift-click the line numbers in the diff to select multiple lines.
  • Finish the review with an overall description of your opinion.

Merger Checklist

  • Make sure the PR passed tests, including the Gitlab tests, for the most recent commit in its branch.
  • Make sure the PR has been reviewed. If not, review it. If it has been reviewed and any requested changes seem to have been addressed, proceed.
  • Merge with the Github "Squash and merge" feature.
    • If there are multiple authors' commits, add Co-authored-by to give credit to all contributing authors.
  • Copy its recommended changelog entry to the Draft Changelog.
  • Append the issue number in parentheses to the changelog entry.

@adamnovak adamnovak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It would be cool if we had this tied in with the same git hook we use to do type checking.

@adamnovak
adamnovak merged commit 227df6c into master Nov 9, 2026
3 checks passed
@adamnovak
adamnovak deleted the spelling branch November 9, 2026 17:04
@adamnovak adamnovak mentioned this pull request Nov 10, 2026
19 tasks
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