don't write ruff output to file (#121)

* don't write ruff output to file * Update ruff instructions in python README --------- Co-authored-by: ok300 <[email protected]>
breez · Jan 12, 2024 · 464a298 · 464a298
1 parent 686b57a
commit 464a298
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -263,7 +263,7 @@ jobs:
 
       - name: Check python formatting
         working-directory: snippets/python/src
-        run: ruff --ignore F841 --ignore F401 --output-format=github .
+        run: ruff check  --ignore F841 --ignore F401 --add-noqa . 
 
       - name: Check python syntax
         working-directory: snippets/python

diff --git a/snippets/python/README.md b/snippets/python/README.md
@@ -14,13 +14,15 @@ cd snippets/python
 python3 -m compileall src
 ```
 
-To check the snippet formatting:
+To check the snippet against formatting and linter rules:
 
 ```bash
 cd snippets/python/src
-ruff --ignore F841 --ignore F401 --output-format=github .
+ruff check --ignore F841 --ignore F401 --add-noqa .
 ```
 
+and fix all occurrences of the `# noqa` directive.
+
 To execute the snippets locally, in order to check for type correctness:
 
 ```bash