From 01ebd019bb94d6f9ca725f0e5fcb7028961415ac Mon Sep 17 00:00:00 2001 From: Frank Harkins Date: Mon, 19 Jun 2023 15:09:26 +0100 Subject: [PATCH] Add instructions on disabling rules globally --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 3bcee1c..0d25d27 100644 --- a/README.md +++ b/README.md @@ -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: @@ -79,6 +80,14 @@ This text will not trigger RuleName ``` +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