Skip to content
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

docs: add missing word #1448

Merged
merged 1 commit into from
Jan 10, 2025
Merged

docs: add missing word #1448

merged 1 commit into from
Jan 10, 2025

Conversation

pdecat
Copy link
Contributor

@pdecat pdecat commented Jan 10, 2025

PR Type

Documentation


Description

  • Fixed a grammatical issue in documentation strings.

  • Replaced "be" with "can be" for clarity.


Changes walkthrough 📝

Relevant files
Documentation
pr_help_message.py
Fix grammatical error in documentation strings                     

pr_agent/tools/pr_help_message.py

  • Corrected grammatical error in two documentation strings.
  • Replaced "be" with "can be" for better readability.
  • +2/-2     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @@ -232,7 +232,7 @@ async def run(self):
    for i in range(len(tool_names)):
    pr_comment += f"\n<tr><td align='left'>\n\n<strong>{tool_names[i]}</strong></td>\n<td>{descriptions[i]}</td>\n<td>\n\n{checkbox_list[i]}\n</td></tr>"
    pr_comment += "</table>\n\n"
    pr_comment += f"""\n\n(1) Note that each tool be [triggered automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) when a new PR is opened, or called manually by [commenting on a PR](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#online-usage)."""
    pr_comment += f"""\n\n(1) Note that each tool can be [triggered automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) when a new PR is opened, or called manually by [commenting on a PR](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#online-usage)."""
    Copy link
    Contributor Author

    @pdecat pdecat Jan 10, 2025

    Choose a reason for hiding this comment

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

    I guess this is the intended meaning, but correct me if I'm wrong.

    @mrT23 mrT23 merged commit b3f116b into qodo-ai:main Jan 10, 2025
    2 checks passed
    @pdecat pdecat deleted the docs/typo branch January 10, 2025 18:16
    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