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

Resolve many typos, clean up via pre-commit #1701

Merged
merged 2 commits into from Sep 6, 2022

Conversation

tomaarsen
Copy link
Contributor

Hello!

Pull request overview

  • Discover typos via codespell and fix them in comments, the README, documentation and tutorials.
  • Run pre-commit run --all to perform reformatting, EOF fixing, removing redundant whitespace, etc.

Note

Surprisingly, running pre-commit introduced many changes, causing this PR to be a bit cluttered. Because of this, I'd recommend reviewing the two commits separately.

  • Tom Aarsen

@frascuchon
Copy link
Member

Hi @tomaarsen and thanks so much for your work.

If you don't mind, I will create a separate PR including only fixes about the pre-commit changes (and include some CI checks to avoid them in the future). Once is done, you could just keep only typo fixes.

@tomaarsen
Copy link
Contributor Author

Seems good!

If you ever run into issues with https://pre-commit.ci/, you can defer to their now-deprecated GitHub action, which can be used like so:
https://github.com/nltk/nltk/blob/2e9cf65072f8cecdc5f2beaa7a66ac8de8f5b31e/.github/workflows/ci.yaml#L20-L26

I did a tiny bit of testing with your approach from #1703, but had not gotten around to applying it fully. I'll be following this to see if it works well for Rubrix!

@frascuchon
Copy link
Member

Thanks @tomaarsen

Finally, I could configure properly the pre-commit checks so new changes in the repo will auto-fix by the pre-commit.ci module. Maybe you find some conflict error if you try to bring changes from the master master branch.

@tomaarsen
Copy link
Contributor Author

Glad you got it working!

Do you need anything from me to get this PR ready for merging?

@frascuchon frascuchon added this to In progress in Release via automation Sep 6, 2022
@frascuchon
Copy link
Member

I don't think so. I will tell you if I need your help. Thanks!!

@frascuchon frascuchon self-requested a review September 6, 2022 15:55
Release automation moved this from In progress to Review OK Sep 6, 2022
@frascuchon frascuchon merged commit 5d9340b into argilla-io:master Sep 6, 2022
Release automation moved this from Review OK to Waiting Release Sep 6, 2022
@tomaarsen tomaarsen deleted the docs/typos branch September 6, 2022 16:03
@frascuchon frascuchon removed this from Waiting Release in Release Sep 13, 2022
@frascuchon frascuchon added this to the v0.18.0 milestone Sep 13, 2022
frascuchon pushed a commit that referenced this pull request Sep 27, 2022
)

* chore: Resolve many typos in documentation, comments and tutorials

Found via codespell (would recommend)

* chore: run pre-commit --all to clean up all files

(cherry picked from commit 5d9340b)
frascuchon pushed a commit that referenced this pull request Sep 27, 2022
)

* chore: Resolve many typos in documentation, comments and tutorials

Found via codespell (would recommend)

* chore: run pre-commit --all to clean up all files

(cherry picked from commit 5d9340b)
frascuchon pushed a commit that referenced this pull request Sep 27, 2022
)

* chore: Resolve many typos in documentation, comments and tutorials

Found via codespell (would recommend)

* chore: run pre-commit --all to clean up all files

(cherry picked from commit 5d9340b)
frascuchon pushed a commit that referenced this pull request Sep 29, 2022
)

* chore: Resolve many typos in documentation, comments and tutorials

Found via codespell (would recommend)

* chore: run pre-commit --all to clean up all files

(cherry picked from commit 5d9340b)
frascuchon pushed a commit that referenced this pull request Oct 3, 2022
)

* chore: Resolve many typos in documentation, comments and tutorials

Found via codespell (would recommend)

* chore: run pre-commit --all to clean up all files

(cherry picked from commit 5d9340b)
frascuchon pushed a commit that referenced this pull request Oct 5, 2022
)

* chore: Resolve many typos in documentation, comments and tutorials

Found via codespell (would recommend)

* chore: run pre-commit --all to clean up all files

(cherry picked from commit 5d9340b)
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.

None yet

2 participants