Skip to content

docs: add documentation for new improve more feature#1543

Merged
mrT23 merged 2 commits intomainfrom
of/update-improve-docs
Feb 17, 2025
Merged

docs: add documentation for new improve more feature#1543
mrT23 merged 2 commits intomainfrom
of/update-improve-docs

Conversation

@ofir-frd
Copy link
Copy Markdown
Collaborator

@ofir-frd ofir-frd commented Feb 17, 2025

PR Type

Documentation


Description

  • Updated documentation for the improve tool features.

  • Added details about the More checkbox functionality.

  • Included new configuration option enable_more_suggestions_checkbox.


Changes walkthrough 📝

Relevant files
Documentation
improve.md
Enhance documentation for `improve` tool features               

docs/docs/tools/improve.md

  • Clarified features exclusive to Qodo Merge💎 users.
  • Added description for the More checkbox functionality.
  • Documented the new enable_more_suggestions_checkbox configuration
    option.
  • +7/-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.
  • @qodo-free-for-open-source-projects
    Copy link
    Copy Markdown
    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
    ⚡ Recommended focus areas for review

    Typo

    The word 'committable' is misspelled in the documentation. It should be 'commitable' to maintain consistency with the previous version.

    - The `Apply this suggestion` checkbox, which interactively converts a suggestion into a committable code comment

    @qodo-free-for-open-source-projects
    Copy link
    Copy Markdown
    Contributor

    qodo-free-for-open-source-projects bot commented Feb 17, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @ofir-frd ofir-frd requested a review from mrT23 February 17, 2025 10:40
    Comment on lines +12 to +14
    Note that the following features are available only for Qodo Merge💎 users:
    - The `Apply this suggestion` checkbox, which interactively converts a suggestion into a committable code comment
    - The `More` checkbox to generate additional suggestions
    Copy link
    Copy Markdown
    Collaborator Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    /implement add a dot at the end of each line

    Copy link
    Copy Markdown
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Code Implementation 🛠️

    Implementation: Add periods at the end of each bullet point for better readability and consistency

    Suggested change
    Note that the following features are available only for Qodo Merge💎 users:
    - The `Apply this suggestion` checkbox, which interactively converts a suggestion into a committable code comment
    - The `More` checkbox to generate additional suggestions
    - The `Apply this suggestion` checkbox, which interactively converts a suggestion into a committable code comment.
    - The `More` checkbox to generate additional suggestions.

    See review comment here

    @mrT23 mrT23 merged commit cfd8138 into main Feb 17, 2025
    2 checks passed
    @mrT23 mrT23 deleted the of/update-improve-docs branch February 17, 2025 15:58
    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.

    2 participants