Skip to content

docs: clarify that .pr_agent.toml can be updated post PR creation #1760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
May 11, 2025
Merged

docs: clarify that .pr_agent.toml can be updated post PR creation #1760

merged 1 commit into from
May 11, 2025

Conversation

isExample
Copy link
Contributor

@isExample isExample commented May 10, 2025 •
edited by qodo-merge-for-open-source bot
Loading

User description

This PR updates the documentation regarding the use of the .pr_agent.toml configuration file.

The previous documentation stated that .pr_agent.toml needs to be uploaded prior to creating a PR in order for the configuration to take effect. However, based on usage, changes to the configuration file can affect PR Agent behavior even after a PR is created, as long as the updated file is in place before the tool is triggered. (e.g., via a comment like /describe).

The phrasing was revised to reduce confusion by clarifying that the configuration must be in place before using PR Agent tools.

PR Type

Documentation

Description

  • Clarifies when .pr_agent.toml configuration changes take effect

  • Updates documentation to reduce confusion about config timing

Changes walkthrough 📝

Relevant files
Documentation
configuration_options.md
Clarify `.pr_agent.toml` timing for configuration application

docs/docs/usage-guide/configuration_options.md

  • Updates explanation about when .pr_agent.toml must be present
  • Specifies config must be in place before using PR Agent tools
  • Removes implication that config only applies at PR creation
    		• +1/-1     
    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
    •

    @qodo-merge-for-open-source Qodo Merge for Open Source
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    @qodo-merge-for-open-source Qodo Merge for Open Source
    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Learned
    best practice
    Improve documentation clarity

    The sentence structure could be improved for better clarity. The parenthetical
    phrase interrupts the flow and makes the sentence harder to parse. Restructuring
    will make it clearer when configuration changes take effect.

    docs/docs/usage-guide/configuration_options.md [42]

    -By uploading a local `.pr_agent.toml` file to the root of the repo's default branch, you can edit and customize any configuration parameter. Note that you need to upload or update `.pr_agent.toml` before using the PR Agent tools (either at PR creation or via manual trigger) for the configuration to take effect.
+By uploading a local `.pr_agent.toml` file to the root of the repo's default branch, you can edit and customize any configuration parameter. Note that for the configuration to take effect, you need to upload or update `.pr_agent.toml` before using the PR Agent tools, whether at PR creation or via manual trigger.
    • Apply / Chat
    Suggestion importance[1-10]: 6

    __

    Why:
    Relevant best practice - Fix typos and grammatical errors in user-facing text, including documentation, error messages, and configuration comments to maintain professionalism and clarity.

    		Low
    • More
    • Author self-review: I have reviewed the PR code suggestions, and addressed the relevant ones.

    @mrT23 mrT23 merged commit 38a81dd into qodo-ai:main May 11, 2025
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @mrT23 mrT23 mrT23 approved these changes

    Assignees
    No one assigned
    Labels
    Review effort 1/5
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @isExample @mrT23