Add Blacklist for Non-Editable File Extensions in Documentation

[hussam789]

PR Type:

Enhancement

---

PR Description:

• This PR addresses the issue of adding documentation to non-editable file extensions like SQL, YAML, etc.
• A blacklist of such file extensions has been added to prevent the addition of inline documentation to these files.
• The changes are mainly in the 'pr_agent/tools/pr_add_docs.py' and 'pr_agent/settings/language_extensions.toml' files.

---

PR Main Files Walkthrough:

files:

pr_agent/tools/pr_add_docs.py: Added a check to disable adding docs to scripts and other non-relevant text files. The blacklist of extensions is fetched from the settings.
pr_agent/settings/language_extensions.toml: Added a new section 'docs_blacklist_extensions' to list the file extensions for which documentation should not be added.

[github-actions]

PR Analysis

• 🎯 Main theme: Adding a blacklist of file extensions to prevent adding docs to scripts and other non-relevant text files.
• 📝 PR summary: This PR introduces a new feature that allows the system to avoid adding documentation to scripts and other non-relevant text files. This is achieved by adding a blacklist of file extensions to the system's settings.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 2, because the PR is small and straightforward, but it's important to ensure that the new feature doesn't introduce any unexpected behavior.
• 🔒 Security concerns: No security concerns found

PR Feedback

• 💡 General suggestions: It would be beneficial to add tests that verify the new functionality. This would help ensure that the system behaves as expected when encountering files with blacklisted extensions.

• 🤖 Code feedback:

  • relevant file: pr_agent/tools/pr_add_docs.py
    suggestion: Consider handling the case where the 'docs_blacklist' setting is not defined. This will prevent potential errors if the setting is missing for any reason. [important]
    relevant line: bad_extensions += get_settings().docs_blacklist_extensions.docs_blacklist

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.

[mrT23]

/describe --pr_description.extra_instructions="use bullet points in 'PR Description' section"

[UjjawalKRoy]

Preparing PR description...

[UjjawalKRoy]

Preparing review...

[UjjawalKRoy]

Preparing review...