Skip to content

Commit

Permalink
fix README (snake to kebab)
Browse files Browse the repository at this point in the history
  • Loading branch information
dorschw committed Dec 4, 2024
1 parent 767957f commit 97e73b9
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ To pass other arguments to Riff (and Ruff), add the `args` key, e.g.
```

### Riff Arguments
* `always_fail_on`: comma-separated list of Ruff error codes. When detected by Ruff, Riff will consider them as failures, even if they're not in lines modified in the current branch.
* `print_github_annotation`: boolean (default `false`). When set to `true`, will add [GitHub Annotations](https://dailystuff.nl/blog/2023/extending-github-actions-with-annotations), making the violations more visible when reviewing code in GitHub's `Modified Files` tab.
* `base_branch`: string (default `origin/main`). Change to `origin/master` or whatever your base branch is named.
* `always-fail-on`: comma-separated list of Ruff error codes. When detected by Ruff, Riff will consider them as failures, even if they're not in lines modified in the current branch.
* `print-github-annotation`: boolean (default `false`). When set to `true`, will add [GitHub Annotations](https://dailystuff.nl/blog/2023/extending-github-actions-with-annotations), making the violations more visible when reviewing code in GitHub's `Modified Files` tab.
* `base-branch`: string (default `origin/main`). Change to `origin/master` or whatever your base branch is named.

## Limitations
* When using Ruff's `--fix` feature, Ruff will fix everything it is [configured](https://beta.ruff.rs/docs/configuration/) to, regardless of the modified lines. Riff cannot control this behavior.
Expand Down

0 comments on commit 97e73b9

Please sign in to comment.