Skip to content

Improve field descriptions for code suggestion model clarity and brevity #1715

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.

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

Merged
merged 1 commit into from
Apr 22, 2025

Conversation

mrT23
Copy link
Collaborator

@mrT23 mrT23 commented Apr 22, 2025

PR Type

enhancement, documentation


Description

  • Refined field descriptions for code suggestion model.

  • Clarified instructions for existing_code and one_sentence_summary.

  • Improved prompt precision and user guidance.


Changes walkthrough 📝

Relevant files
Documentation
pr_code_suggestions_prompts_not_decoupled.toml
Improved field descriptions and prompt clarity                     

pr_agent/settings/code_suggestions/pr_code_suggestions_prompts_not_decoupled.toml

  • Clarified existing_code field to specify no diff prefixes and ellipsis
    usage.
  • Refined one_sentence_summary to avoid mentioning method or variable
    names.
  • Enhanced overall prompt clarity and user instructions.
  • +2/-2     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • 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

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @mrT23 mrT23 merged commit 47e46ee into main Apr 22, 2025
    2 checks passed
    @mrT23 mrT23 deleted the tr/improve_prompts branch April 22, 2025 11:22
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant