Skip to content

Document rule selection args#167

Merged
ntBre merged 2 commits into
astral-sh:mainfrom
Herrtian:document-rule-args
May 14, 2026
Merged

Document rule selection args#167
ntBre merged 2 commits into
astral-sh:mainfrom
Herrtian:document-rule-args

Conversation

@Herrtian

Copy link
Copy Markdown
Contributor

Closes #107.

Adds a short README example for passing rule-selection options through the Ruff hook args, including quoted comma-separated values in inline YAML.

Checks: git diff --check; parsed the YAML example.

@ntBre ntBre added the documentation Improvements or additions to documentation label May 14, 2026

@ntBre ntBre left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I tested this in a local repo, and it works!

I'll apply one suggestion bumping the Ruff version after the release today, but this is otherwise good to go.

Comment thread README.md Outdated
@ntBre ntBre merged commit 7b9f758 into astral-sh:main May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add instructions in README for how to select ruff linter rules or ignore others

2 participants