diff --git a/README.md b/README.md index 00b7439..77fc7ed 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Flake8 Linter Action -This action run Flake8 over a project and comment on PR the errors found. +This action runs Flake8 over a project and comment on PR the errors found. ### Install dependencies @@ -57,8 +57,6 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} pr_number: ${{ github.event.number }} - - ``` ## Inputs @@ -73,11 +71,11 @@ The GitHub token to use for making API requests. **Required** -Pull Request number that trigger build. +Pull Request number triggered the build. ## Configure rules and analysis via `setup.cfg` -In order to configure the ESLint analysis for your project, you must create or modify the `setup.cfg` file at the root of your project. +In order to configure the Flake8 analysis for your project, you must create or modify the `setup.cfg` file at the root of your project. Here follows an example for `setup.cfg`: diff --git a/action.yml b/action.yml index 1e01d6b..2a90360 100644 --- a/action.yml +++ b/action.yml @@ -1,5 +1,5 @@ name: 'Flake8 Style Evaluator' -description: 'Run Flake8 over a project and comment on the student PR the errors found.' +description: 'Runs Flake8 over a project and comment on the student PR the errors found.' inputs: token: description: 'The GitHub token to use for making API requests.' diff --git a/src/main.py b/src/main.py index 807269b..4e0c658 100644 --- a/src/main.py +++ b/src/main.py @@ -35,7 +35,7 @@ def build_comment(feedback): msg = 'Foram encontrados {} erros'.format(feedback['count']) if feedback['count'] == 1: - msg = 'Foi encontrado {} erro'.format(feedback['count']) + msg = 'Foi encontrado 1 erro' comment = '### {}.\n'.format(msg) for file in feedback['files']: @@ -56,7 +56,7 @@ def comment_on_pr(comment): if __name__ == "__main__": if len(sys.argv) < 2: - raise ValueError('You must pass report and requirements files as argument!') + raise ValueError('You must pass report and requirements files as arguments!') feedback = format_feedback(sys.argv[1]) comment = build_comment(feedback)