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

[Docs] Add code-spell pre-commit hook and fix a large mount of typos. #470

Merged
merged 4 commits into from
Oct 13, 2021

Conversation

mzr1996
Copy link
Member

@mzr1996 mzr1996 commented Sep 28, 2021

Motivation

Refers to open-mmlab/mmdetection#6099, this hook can check all typos in the code, it can help us to avoid typos.

Modification

As the title.

BC-breaking (Optional)

It may break CI if new PRs have typos.

Use cases (Optional)

No, just a pre-commit hook.

Checklist

Before PR:

  • Pre-commit or other linting tools are used to fix the potential lint issues.
  • Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests.
  • The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, like docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with those projects, like MMDet or MMSeg.
  • CLA has been signed and all committers have signed the CLA in this PR.

@mzr1996 mzr1996 requested a review from Ezra-Yu September 28, 2021 11:48
@mzr1996 mzr1996 changed the title [Docs] Add code-spell pre-commit hook and fix large mount of typos. [Docs] Add code-spell pre-commit hook and fix a large mount of typos. Sep 28, 2021
Copy link
Collaborator

@Ezra-Yu Ezra-Yu left a comment

Choose a reason for hiding this comment

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

LGTM.

@codecov
Copy link

codecov bot commented Sep 28, 2021

Codecov Report

Merging #470 (53df664) into master (6fba107) will decrease coverage by 0.04%.
The diff coverage is 42.70%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #470      +/-   ##
==========================================
- Coverage   78.01%   77.97%   -0.05%     
==========================================
  Files         101      102       +1     
  Lines        5617     5620       +3     
  Branches      923      923              
==========================================
  Hits         4382     4382              
- Misses       1108     1111       +3     
  Partials      127      127              
Flag Coverage Δ
unittests 77.97% <42.70%> (-0.05%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
mmcls/core/visualization/image.py 89.07% <ø> (ø)
mmcls/datasets/pipelines/formating.py 0.00% <0.00%> (-43.48%) ⬇️
mmcls/datasets/pipelines/transforms.py 86.81% <ø> (ø)
mmcls/models/backbones/mobilenet_v3.py 100.00% <ø> (ø)
mmcls/models/backbones/regnet.py 98.03% <ø> (ø)
mmcls/models/backbones/repvgg.py 96.84% <ø> (ø)
mmcls/models/backbones/tnt.py 99.08% <ø> (ø)
mmcls/models/backbones/vgg.py 86.58% <ø> (ø)
mmcls/models/backbones/vision_transformer.py 77.54% <ø> (ø)
mmcls/models/classifiers/base.py 69.62% <ø> (ø)
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6fba107...53df664. Read the comment docs.

Copy link
Collaborator

@Ezra-Yu Ezra-Yu left a comment

Choose a reason for hiding this comment

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

LGTM.

@mzr1996 mzr1996 merged commit 2e6c7cf into open-mmlab:master Oct 13, 2021
@mzr1996 mzr1996 deleted the code-spell branch July 20, 2022 06:54
mzr1996 added a commit to mzr1996/mmpretrain that referenced this pull request Nov 24, 2022
…open-mmlab#470)

* Add code spell check hook

* Add codespell config

* Fix a lot of typos.

* Add formating.py to keep compatibility.
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.

2 participants