Skip to content

Commit 8877289

Browse files
authored
Update README.md
1 parent 40b9be2 commit 8877289

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## GitHub Action to find Python syntax errors and undefined names
1+
## GitHub Action to find Python 3 syntax errors and undefined names
22

33
An action that runs selected [flake8](http://flake8.pycqa.org) tests on the Python code in your repo. If ___syntax errors or undefined names___ are found in the Python code then the action will fail.
44

5-
Example workflow (`.github/main.workflow`):
5+
Example workflow (Put the following text into `.github/main.workflow`):
66
```
77
workflow "New workflow" {
88
on = "push"
@@ -13,6 +13,7 @@ action "Find Python 3 syntax errors and undefined names" {
1313
uses = "cclauss/Find-Python-syntax-errors-action@master"
1414
}
1515
```
16+
## How does this Action Python 3 syntax errors and undefined names?
1617
$ __flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics__
1718

1819
__E901,E999,F821,F822,F823__ are the "_showstopper_" [flake8](http://flake8.pycqa.org) issues that can halt the runtime with a SyntaxError, NameError, etc. These 5 are different from most other flake8 issues which are merely "style violations" -- useful for readability but they do not effect runtime safety.

0 commit comments

Comments
 (0)