docs: document the config input parameter#97
Merged
larsoner merged 2 commits intoJun 1, 2026
Conversation
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>
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>
Member
|
Thanks @ehennestad ! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The action exposes a
configinput inaction.yml, andentrypoint.shmaps it to codespell's--configflag. However, it was the only input missing from the README's parameter list.This PR adds a
### Parameter: configsection, formatted consistently with the other documented parameters.🤖 Generated with Claude Code