[Enhance] Add code-spell pre-commit hook and fix a typo. (open-mmlab#…

…6306) * pre-commit: Add codespell to look for typos * fixup! Indentation * Fix a typo and add ignore_words * Fix a typo * Should use lowercase Co-authored-by: Christian Clauss <[email protected]>
jozhang97 · Oct 18, 2021 · c1302d5 · c1302d5
1 parent 0d02ccd
commit c1302d5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -33,6 +33,10 @@ repos:
     hooks:
       - id: markdownlint
         args: ["-r", "~MD002,~MD013,~MD024,~MD029,~MD033,~MD034,~MD036", "-t", "allow_different_nesting"]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.1.0
+    hooks:
+      - id: codespell
   - repo: https://github.com/myint/docformatter
     rev: v1.3.1
     hooks:

diff --git a/docs/tutorials/customize_runtime.md b/docs/tutorials/customize_runtime.md
@@ -113,7 +113,7 @@ Tricks not implemented by the optimizer should be implemented through optimizer
         _delete_=True, grad_clip=dict(max_norm=35, norm_type=2))
     ```
 
-    If your config inherits the base config which already sets the `optimizer_config`, you might need `_delete_=True` to overide the unnecessary settings. See the [config documentation](https://mmdetection.readthedocs.io/en/latest/tutorials/config.html) for more details.
+    If your config inherits the base config which already sets the `optimizer_config`, you might need `_delete_=True` to override the unnecessary settings. See the [config documentation](https://mmdetection.readthedocs.io/en/latest/tutorials/config.html) for more details.
 
 - __Use momentum schedule to accelerate model convergence__:
     We support momentum scheduler to modify model's momentum according to learning rate, which could make the model converge in a faster way.

diff --git a/setup.cfg b/setup.cfg
@@ -11,3 +11,8 @@ default_section = THIRDPARTY
 BASED_ON_STYLE = pep8
 BLANK_LINE_BEFORE_NESTED_CLASS_OR_DEF = true
 SPLIT_BEFORE_EXPRESSION_AFTER_OPENING_PAREN = true
+
+[codespell]
+skip = *.ipynb
+quiet-level = 3
+ignore-words-list = patten,nd,ty,mot,hist,formating,winn,gool,datas,wan