Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add codespell GitHub Action #34

Closed
wants to merge 1 commit into from
Closed

Add codespell GitHub Action #34

wants to merge 1 commit into from

Conversation

ccoVeille
Copy link
Contributor

@ccoVeille
Copy link
Contributor Author

ccoVeille commented Apr 18, 2024 •
edited
Loading

@Julien-cpsn it's ready

I can simulate someone adding a typo if needed

Julien-cpsn
Julien-cpsn reviewed Apr 19, 2024
View reviewed changes
.github/codespell-ignore.txt Outdated
crate
ratatui
lient
ody
Copy link
Owner

@Julien-cpsn Julien-cpsn Apr 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Can't find this one in the code base (ody)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Patterns like this in readme

**B**ody

And this in code

{B}ody
(B)ody

You can install codespell locally and launch it, after removing the lines.

@Julien-cpsn
Copy link
Owner

Great!
I am not quite sure I understand which benefits it would bring. Can you explain some more please?
Like how is the ouput? Does it make suggestions or correct things directly?

Thanks in advance

@ccoVeille
Copy link
Contributor Author

Great!
I am not quite sure I understand which benefits it would bring. Can you explain some more please?
Like how is the ouput? Does it make suggestions or correct things directly?

Thanks in advance

I will create another branch with a typo, to show you.

@Julien-cpsn
Copy link
Owner

@ccoVeille hmmmm I don't see anything special? Maybe I am missing something?

@ccoVeille
Copy link
Contributor Author

It looks like this when the codespell github action catch something

https://github.com/Julien-cpsn/ATAC/pull/36/files

image

Unfortunately, it doesn't catch most of the errors I added

@ccoVeille
Copy link
Contributor Author

@Julien-cpsn The results are way better with typos #38 than #36

I will close #34 in favor of #37

@ccoVeille ccoVeille closed this Apr 19, 2024
@ccoVeille ccoVeille deleted the github-action-codespell branch April 19, 2024 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Julien-cpsn Julien-cpsn Julien-cpsn left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add typo spelling GitHub actions
2 participants
@ccoVeille @Julien-cpsn