Skip to content

Commit

Permalink
📝 Updates documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rickstaa committed Dec 10, 2020
1 parent 1d667bd commit bd3842f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![Windows CI](https://github.com/rickstaa/action-flake8/workflows/Windows%20CI/badge.svg)](https://github.com/rickstaa/action-flake8/actions?query=workflow%3A%22Windows+CI%22)
[![Lint](https://github.com/rickstaa/action-flake8/workflows/Lint/badge.svg)](https://github.com/rickstaa/action-flake8/actions?query=workflow%3ALint)

This action runs flak8 with [reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to lint to lint python source files while creating annotations. It does this by installing the Python [flake8 package](https://pypi.org/project/flake8/) in an environment with a Python interpreter and executes flake8 stylistic and logical linting of Python source files. Following [reviewdog](https://github.com/reviewdog/reviewdog) is used to parse the bash output into github annotations. Flake8 and reviewdog installation and execution defaults can be configured with optional Action settings.
This action runs flake8 with [reviewdog](https://github.com/reviewdog/reviewdog) on pull requests to lint to lint python source files while creating annotations. It does this by installing the Python [flake8 package](https://pypi.org/project/flake8/) in an environment with a Python interpreter and executes flake8 stylistic and logical linting of Python source files. Following [reviewdog](https://github.com/reviewdog/reviewdog) is used to parse the bash output into github annotations. Flake8 and reviewdog installation and execution defaults can be configured with optional Action settings.

## Quick Start

Expand Down

0 comments on commit bd3842f

Please sign in to comment.