Skip to content

Commit 3b7da26

Browse files
ehennestadclaude
andauthored
docs: document the config input parameter (#97)
* docs: document the config input parameter The config input maps to codespell's --config flag in entrypoint.sh but was missing from the README. Add a parameter section for it, consistent with the other documented inputs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * docs: clarify config input vs. auto-discovered config files setup.cfg/.codespellrc/pyproject.toml are read automatically; the config input is for pointing at a config file in a non-standard location. Use a non-standard path in the example to reflect that. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 4848b4c commit 3b7da26

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,18 @@ with:
4646
exclude_file: src/foo
4747
```
4848

49+
### Parameter: config
50+
51+
Path to a `codespell` config file. The file uses INI format with a `[codespell]` section.
52+
53+
This parameter is optional. By default `codespell` automatically reads configuration from `pyproject.toml`, `setup.cfg`, and `.codespellrc` in the working directory; use this parameter only to point at a config file in a non-standard location.
54+
55+
```yml
56+
uses: codespell-project/actions-codespell@v2
57+
with:
58+
config: path/to/codespell.cfg
59+
```
60+
4961
### Parameter: skip
5062

5163
Comma-separated list of files to skip (it accepts globs as well).

0 commit comments

Comments
 (0)