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

Typos fixed #2893

Merged
merged 7 commits into from Mar 27, 2021
Merged

Typos fixed #2893

merged 7 commits into from Mar 27, 2021

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Mar 8, 2021

I am using https://github.com/codespell-project/codespell to find typos, it works pretty well!
We can even automate this check later on:

  • We need to create whitelist.txt of words that are ignored, like strat
  • We need to define what files and folders to skip completely

Full example: https://github.com/dry-python/returns/blob/master/setup.cfg#L191-L194

@sobolevn sobolevn requested a review from DRMacIver as a code owner March 8, 2021 07:54
@Zac-HD Zac-HD added docs documentation could *always* be better legibility make errors helpful and Hypothesis grokable labels Mar 9, 2021
@Zac-HD
Copy link
Member

Zac-HD commented Mar 9, 2021

LGTM!

I also tried to automate this as part of our lint and format jobs, but it didn't quite work 😞
Up to you whether you'd prefer to finish doing so or just roll it back.

@sobolevn
Copy link
Member Author

sobolevn commented Mar 9, 2021

@Zac-HD thanks a lot for your help! I will finish it next week 👍

@sobolevn sobolevn requested a review from Zac-HD as a code owner March 26, 2021 16:08
@sobolevn
Copy link
Member Author

It took me more time than a week 😅

Copy link
Member

@Zac-HD Zac-HD left a comment

Choose a reason for hiding this comment

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

Two tiny nitpicks, but looks good to me overall - thanks for fixing this up, and feel free to merge when you think it's done.

tooling/src/hypothesistooling/__main__.py Outdated Show resolved Hide resolved
"--check-hidden",
"--check-filenames",
"--ignore-words=./tooling/ignore-list.txt",
"--skip=__pycache__,_build,.mypy_cache,.venv,.git,tlds-alpha-by-domain.txt",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"--skip=__pycache__,_build,.mypy_cache,.venv,.git,tlds-alpha-by-domain.txt",

These are already handled by the logic which chooses while files to format, or the comprehension in lint().

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually, no. We still need this line for some reason.
I was also surprised.

Proof (calling codespell without --skip) by TASK=codespell ./build.sh:
Снимок экрана 2021-03-27 в 8 51 25

Copy link
Member

Choose a reason for hiding this comment

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

Weird! If that's how it works though, let's leave it as-is 🙂

@sobolevn sobolevn merged commit f74608a into master Mar 27, 2021
@sobolevn sobolevn deleted the fixing-typos branch March 27, 2021 07:10
@sobolevn
Copy link
Member Author

Thanks a lot, @Zac-HD! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation could *always* be better legibility make errors helpful and Hypothesis grokable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants