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.

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

Add codespell to tox #8423

Closed
wants to merge 1 commit into from
Closed

Conversation

cclauss
Copy link
Contributor

@cclauss cclauss commented Aug 17, 2021

Add codespell to our tox testing to ensure that we do not have regressions on the typo fixes in #8409, #8419, #8420, and #8421.

tox.ini Outdated Show resolved Hide resolved
tox.ini Outdated Show resolved Hide resolved
@cclauss cclauss changed the title Add codespell to tox Do not add codespell to tox Aug 18, 2021
@cclauss cclauss changed the title Do not add codespell to tox Add codespell to tox Aug 18, 2021
@cclauss cclauss force-pushed the Add-codespell-to-tox branch 2 times, most recently from da543d5 to 59759d4 Compare August 18, 2021 16:40
Comment on lines +31 to +30
[codespell]
ignore-words-list = ba,configurtion,ded,hel,perfom,wile
skip = *.css,*.fjson,*.js,*.po,*.svg
Copy link
Member

Choose a reason for hiding this comment

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

We are only running this inside our docs for now, should be in docs/.codespellrc

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Codespell runs successfully across the entire repo.

Copy link
Member

Choose a reason for hiding this comment

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

I think it makes sense to run only for docs/ directory. That way we will reduce the execution time required. It seems the whole project takes +2 minutes to run otherwise, which is a lot: #8423 (comment)

Can you change this to run only on docs/ directory?

Copy link
Contributor Author

@cclauss cclauss Mar 2, 2022

Choose a reason for hiding this comment

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

Why does it make sense to ignore typos in other parts of the codebase?

The typos fixed in this PR are user-facing but they are not in docs/.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, I think I missundertood your comment. tox -e lint is the one that takes 2+ minutes. It seems that codespell only takes 2s to run?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

codespell is really fast.

@cclauss
Copy link
Contributor Author

cclauss commented Aug 20, 2021

The tox jobs in CircleCI are sorted so the quickest jobs run first to provide fail-fast signals to contributors. Another approach would be to run the ~2m30s+ tox -e lint task in a separate CircleCI job.

@stale
Copy link

stale bot commented Mar 2, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added Status: stale Issue will be considered inactive soon and removed Status: stale Issue will be considered inactive soon labels Mar 2, 2022
@humitos
Copy link
Member

humitos commented Mar 2, 2022

I suggested changing the conf to only run on docs/ directory to speed up things. Is there anything else required to be able to merge this PR?

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@cclauss can you please solve the conflicts so we merge it?

@cclauss cclauss requested a review from a team as a code owner March 2, 2022 13:43
@cclauss cclauss requested a review from a team as a code owner March 2, 2022 15:00
@cclauss cclauss closed this Mar 2, 2022
@cclauss cclauss deleted the Add-codespell-to-tox branch March 2, 2022 15:46
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.

3 participants