Docs: Add proselint

.github/workflows/tests.yml

@@ -44,7 +44,7 @@ jobs:
             setup.py
 
       - name: Run tests
-        run: make test
+        run: make check
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3

.proselintrc.json

@@ -0,0 +1,6 @@
+{
+  "checks": {
+    "annotations.misc": false,
+    "typography.symbols": false
+  }
+}

CHANGES.rst

@@ -18,6 +18,7 @@ development
 - Docs: Add configuration for "Read the Docs"
 - Docs: Make the "forecast" feature less prominent, because it
   only offers a naive approach.
+- Docs: Add proselint
 
 2020-12-29 0.11.0
 =================
@@ -50,7 +51,7 @@ development
 2020-01-07 0.9.0
 ================
 - Upgrade release support packages "twine" and "keyring"
-- Change base URL to new opendata URL. Thanks, @mgrrx!
+- Change base URL to new opendata URL. Thanks, @mgrrx.
 - Futurize for Python 3 compatibility.
 
 2018-03-29 0.8.0
@@ -115,7 +116,7 @@ development
 2018-03-14 0.4.0
 ================
 - Refactoring and modularization
-- Make FTP client wrapper for DWD CDC server more universal
+- Make FTP client wrapper for DWD CDC server universal
 - Improve inline documentation
 - Improve CSV import string data cleansing and integer type coercion
 - Improve filtering mechanics

Makefile

@@ -8,6 +8,7 @@ $(eval python       := $(venv)/bin/python)
 $(eval pytest       := $(venv)/bin/pytest)
 $(eval bumpversion  := $(venv)/bin/bumpversion)
 $(eval twine        := $(venv)/bin/twine)
+$(eval proselint    := $(venv)/bin/proselint)
 
 
 # ============
@@ -29,6 +30,11 @@ docs-html: install-doctools
 	touch doc/index.rst
 	export SPHINXBUILD="`pwd`/$(venv)/bin/sphinx-build"; cd doc; make html
 
+docs-lint: install-tests
+	$(proselint) *.rst doc/**/*.rst
+
+check: docs-lint test
+
 
 # ===============
 # Utility targets

requirements-tests.txt

@@ -1,5 +1,6 @@
 datadiff>=2.0,<3
 marko<2
+proselint==0.13.0
 pytest>=6.1.0,<8
 pytest-cov<5
 pytest-doctest-ellipsis-markers