Skip to content

Commit

Permalink
Add instructions on disabling rules globally
Browse files Browse the repository at this point in the history
  • Loading branch information
frankharkins authored Jun 19, 2023
1 parent f7083b1 commit 01ebd01
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ reference.
## Ignoring rules

If you find a false positive, please [make an issue](https://github.com/IBM/ibm-quantum-style-guide/issues/new/choose).

If the rule is working correctly but you still want
to disable it, you can turn specific rules off for
sections of text using these comments:
Expand All @@ -79,6 +80,14 @@ This text will not trigger RuleName
<!-- vale IBMQuantum.RuleName = YES -->
```

If the rule isn't appropriate for your repo, you can
disable it everywhere by adding this line to your
`.vale.ini`:

```ini
IBMQuantum.RuleName = NO
```


## Keeping up to date

Expand Down

0 comments on commit 01ebd01

Please sign in to comment.