From 30248c2a7bcd102095c859be64b1573b57592e43 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Thu, 6 Jul 2023 17:34:40 +0300 Subject: [PATCH] readme update --- README.md | 16 +++++++--------- pr_agent/tools/pr_reviewer.py | 2 +- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f9bad2b9..0eebb162 100644 --- a/README.md +++ b/README.md @@ -181,13 +181,15 @@ This is how a typical output of the PR Reviewer looks like: - 🤖 **Code suggestions:** -- **suggestion 1:** - - **relevant file:** pr_agent/algo/language_handler.py - - **suggestion content:** Consider using a set instead of a list for 'bad_extensions' as checking membership in a set is faster than in a list. [medium] -- **suggestion 2:** - **relevant file:** pr_agent/algo/language_handler.py - - **suggestion content:** In the 'filter_bad_extensions' function, you are splitting the filename on '.' and taking the last element to get the extension. This might not work as expected if the filename contains multiple '.' characters. Consider using 'os.path.splitext' to get the file extension more reliably. [important] + + **suggestion content:** Consider using a set instead of a list for 'bad_extensions' as checking membership in a set is faster than in a list. [medium] + + + - **relevant file:** pr_agent/algo/language_handler.py + + **suggestion content:** In the 'filter_bad_extensions' function, you are splitting the filename on '.' and taking the last element to get the extension. This might not work as expected if the filename contains multiple '.' characters. Consider using 'os.path.splitext' to get the file extension more reliably. [important] --- @@ -230,16 +232,12 @@ This is a comparison of the regular and extended code suggestions modes: --- Example for regular suggestion: - -- **suggestion 1:** - **relevant file:** sql.py - **suggestion content:** Remove hardcoded sensitive information like username and password. Use environment variables or a secure method to store these values. [important] --- Example for extended suggestion: - -- **suggestion 1:** - **relevant file:** sql.py - **suggestion content:** Remove hardcoded sensitive information (username and password) [important] - **why:** Hardcoding sensitive information is a security risk. It's better to use environment variables or a secure way to store these values. diff --git a/pr_agent/tools/pr_reviewer.py b/pr_agent/tools/pr_reviewer.py index a7ebc2ef..9ac25063 100644 --- a/pr_agent/tools/pr_reviewer.py +++ b/pr_agent/tools/pr_reviewer.py @@ -26,7 +26,7 @@ class PRReviewer: "title": self.git_provider.pr.title, "branch": self.git_provider.get_pr_branch(), "description": self.git_provider.pr.body, - "language": self.git_provider.get_main_pr_language(), + "language": self.main_language, "diff": "", # empty diff for initial calculation "require_tests": settings.pr_reviewer.require_tests_review, "require_security": settings.pr_reviewer.require_security_review,