Merge branch 'master' of github.com:rojopolis/spellcheck-github-actions

rojopolis · Feb 6, 2024 · dbd2f1d · dbd2f1d
2 parents 9fa1ede + 6d918b6
commit dbd2f1d
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -395,6 +395,40 @@ matrix:
 
 Change the configuration to suit your repository and needs, please see the `examples/` directory for more example configurations.
 
+## Specifying Number of Jobs for Parallel Processing
+
+This action supports parallel processing of the configured tasks, this is done using the `jobs` parameter. Introduced in version 4.10 of **PySpelling**.
+
+The default value is `1`, which means that the action will run in a single job.
+
+```yaml
+jobs: 4
+```
+
+Full example:
+
+```yaml
+jobs: 4
+matrix:
+- name: Markdown
+  aspell:
+    lang: en
+  dictionary:
+    wordlists:
+    - .wordlist.txt
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+  - pyspelling.filters.html:
+      comments: false
+      ignores:
+      - code
+      - pre
+  sources:
+  - '**/*.md'
+  default_encoding: utf-8
+```
+
 ## Specifying Language
 
 This action currently only support `aspell`, please see the section on Language Support below.

diff --git a/requirements.txt b/requirements.txt
@@ -5,7 +5,7 @@ html5lib==1.1
 lxml==4.9.3
 Markdown==3.4.4
 pymdown-extensions==10.4
-pyspelling==2.9
+pyspelling==2.10
 PyYAML==6.0.1
 six==1.16.0
 soupsieve==2.5