Skip to content

Conversation

@yarikoptic
Copy link
Contributor

@yarikoptic yarikoptic commented Jan 24, 2025

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

TODOs

  • verify if pre-commit hooked into CI and remove TEMP commit and potentially workflow too

Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

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

3 files reviewed, 2 total issue(s) found.

@yarikoptic
Copy link
Contributor Author

ok, CI / lint did run pre-commit and detected typo, removing custom workflow and TEMP commit.

…agically

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@yarikoptic yarikoptic marked this pull request as ready for review January 24, 2025 02:15
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

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

2 files reviewed, 1 total issue(s) found.

Copy link
Contributor

@sydney-runkle sydney-runkle left a comment

Choose a reason for hiding this comment

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

Thanks!

We might want to tweak the ignore-regex down the line, but this setup looks similar to what we have in pydantic, so happy to accept this improvement!

@sydney-runkle sydney-runkle added the documentation Improvements or additions to documentation label Jan 24, 2025
@sydney-runkle sydney-runkle merged commit 3ecd924 into pydantic:main Jan 24, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants