← Back to team overview

launchpad-reviewers team mailing list archive

[Merge] ~cjwatson/launchpad:doc-codespell into launchpad:master

 

Colin Watson has proposed merging ~cjwatson/launchpad:doc-codespell into launchpad:master.

Commit message:
Apply codespell to *.rst files under doc/

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~cjwatson/launchpad/+git/launchpad/+merge/426317

I've had a brief look at the output of this tool and it looks like it might well be the sort of thing we could apply to the whole Launchpad tree with only a relatively small number of exceptions, but applying it to our developer documentation is a start.
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~cjwatson/launchpad:doc-codespell into launchpad:master.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index accf87d..d985aac 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -110,3 +110,8 @@ repos:
     rev: v0.8.0.4
     hooks:
     -   id: shellcheck
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.1.0
+    hooks:
+    -   id: codespell
+        files: ^doc/.*\.rst$
diff --git a/doc/explanation/architecture.rst b/doc/explanation/architecture.rst
index cd40b8d..04e75dc 100644
--- a/doc/explanation/architecture.rst
+++ b/doc/explanation/architecture.rst
@@ -35,7 +35,7 @@ Related documents
 
 Launchpad is moving to a `services-based design
 <https://dev.launchpad.net/ArchitectureGuide/Services>`_.  This is intended
-to faciliate achieving many of the goals from this guide.
+to facilitate achieving many of the goals from this guide.
 
 The :doc:`Python style guide <../reference/python>` specifies coding style guidelines.