Merge pull request #85 from bobleesj/codespell

Add Codespell in pre-commit, fix typos

Author: sbillinge

.codespell/ignore_lines.txt

@@ -0,0 +1,2 @@
+;; Please include filenames and explanations for each ignored line.
+;; See https://docs.openverse.org/meta/codespell.html for docs.

.codespell/ignore_words.txt

@@ -0,0 +1,17 @@
+;; Please include explanations for each ignored word (lowercase).
+;; See https://docs.openverse.org/meta/codespell.html for docs.
+
+;; abbreviation for "materials" often used in a journal title
+mater
+
+;; alternative use of socioeconomic
+socio-economic
+
+;; Frobenius norm used in np.linalg.norm
+fro
+
+;; parameter in xtick.direction in matplotlib i.g. in, out, inout
+inout
+
+;; repository name: https://github.com/regro/rever
+rever

.pre-commit-config.yaml

@@ -44,3 +44,9 @@ repos:
         name: Prevent Commit to Main Branch
         args: ["--branch", "main"]
         stages: [pre-commit]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+    - id: codespell
+      additional_dependencies:
+        - tomli

README.rst

@@ -145,7 +145,7 @@ You can also update style parameters locally by using the matplotlib style conte
             plt.ylabel('some numbers')
         plt.show()
 
-Here are a snapshot of values in ``all_styles["bg-style"]`` sheet which you may override with ``rc.parms`` to fine tune things: ::
+Here are a snapshot of values in ``all_styles["bg-style"]`` sheet which you may override with ``rc.params`` to fine tune things: ::
 
         'lines.linewidth':       2.50,
         'lines.markeredgewidth': 0.25,
@@ -307,7 +307,7 @@ trying to commit again.
 
 Improvements and fixes are always appreciated.
 
-Before contribuing, please read our `Code of Conduct <https://github.com/Billingegroup/bg-mpl-stylesheets/blob/main/CODE_OF_CONDUCT.rst>`_.
+Before contributing, please read our `Code of Conduct <https://github.com/Billingegroup/bg-mpl-stylesheets/blob/main/CODE_OF_CONDUCT.rst>`_.
 
 Contact
 -------

news/codespell.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* Spelling check via Codespell in pre-commit
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

pyproject.toml

@@ -51,6 +51,11 @@ namespaces = false  # to disable scanning PEP 420 namespaces (true by default)
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements/pip.txt"]}
 
+[tool.codespell]
+exclude-file = ".codespell/ignore_lines.txt"
+ignore-words = ".codespell/ignore_words.txt"
+skip = "*.cif,*.dat"
+
 [tool.black]
 line-length = 115
 include = '\.pyi?$'

src/bg_mpl_stylesheets/bg_mpl_stylesheet

@@ -524,7 +524,7 @@ figure.facecolor : w           ## figure facecolor; 0.75 is scalar gray
 #savefig.format      : png      ## png, ps, pdf, svg
 savefig.bbox         : tight    ## 'tight' or 'standard'.
                                 ## 'tight' is incompatible with pipe-based animation
-                                ## backends but will workd with temporary file based ones:
+                                ## backends but will work with temporary file based ones:
                                 ## e.g. setting animation.writer to ffmpeg will not work,
                                 ## use ffmpeg_file instead
 #savefig.pad_inches  : 0.1      ## Padding to be used when bbox is set to 'tight'