Update Review Guidelines to Exclude Comments

[mrT23]

PR Type:

Documentation

---

PR Description:

This PR updates the review guidelines in two configuration files. The changes specify that reviewers should not suggest adding docstrings, type hints, or comments to the code. This update is reflected in both 'pr_code_suggestions_prompts.toml' and 'pr_reviewer_prompts.toml' files.

---

PR Main Files Walkthrough:

files:

pr_agent/settings/pr_code_suggestions_prompts.toml: The instructions for code suggestions have been updated to include 'comments' in the list of items that should not be suggested for addition.
pr_agent/settings/pr_reviewer_prompts.toml: The review guidelines have been updated to specify that reviewers should not suggest adding docstrings, type hints, or comments.

[mrT23]

/describe

[github-actions]

PR Analysis

• 🎯 Main theme: Updating instructions for PR reviewers and code suggestion prompts
• 📝 PR summary: This PR updates the instructions for PR reviewers and code suggestion prompts to include a directive not to suggest adding comments, in addition to the existing directives not to suggest adding docstrings or type hints.
• 📌 Type of PR: Documentation
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 1
  The PR is straightforward and involves only text changes in instructions. No code or logic has been altered.
• 🔒 Security concerns: No

PR Feedback

• 💡 General suggestions: The changes made in the PR are clear and straightforward. However, it would be beneficial to provide a rationale for not suggesting comments in the PR. This could help contributors understand the reasoning behind this guideline.

• 🤖 Code feedback:

  • relevant file: pr_agent/settings/pr_code_suggestions_prompts.toml
    suggestion: Consider adding a rationale for not suggesting comments in the PR. This could be done by appending a sentence explaining the reasoning behind this guideline. [medium]
    relevant line: Don't suggest to add docstring, type hints, or comments.

  • relevant file: pr_agent/settings/pr_reviewer_prompts.toml
    suggestion: Similar to the previous suggestion, consider adding a rationale for not suggesting comments in the PR. This could be done by appending a sentence explaining the reasoning behind this guideline. [medium]
    relevant line: - Don't suggest to add docstring, type hints, or comments.

How to use

To invoke the PR-Agent, add a comment using one of the following commands:
/review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option.
/describe: Modify the PR title and description based on the contents of the PR.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.