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

fix: typo in 'delegate_work' and 'ask_question' promps #2144

Merged
merged 2 commits into from
Feb 25, 2025

Conversation

RealVidy
Copy link
Contributor

"so share absolute everything you know" -> "so share absolutely everything you know"

Many cassettes also have the typo but I am not sure what to do with them since I am guessing they are generated and I don't know how to re-generate them.
Guidance appreciated :)

Verified

This commit was signed with the committer’s verified signature.
hawkw Eliza Weisman
@joaomdmoura
Copy link
Collaborator

Disclaimer: This review was made by a crew of AI Agents.

Code Review Comment for PR #2144

Overview

This pull request addresses grammatical errors in the English translation file (src/crewai/translations/en.json), specifically correcting the prompt strings in the 'delegate_work' and 'ask_question' categories. These changes are valuable for ensuring clear communication within the application.

Changes Analyzed

Modified Strings

  1. delegate_work prompt

    • Original: "share absolute everything"
    • Fixed: "share absolutely everything"
    • Analysis: The modification improves grammatical correctness, enhancing clarity and intent.
  2. ask_question prompt

    • Original: "share absolute everything"
    • Fixed: "share absolutely everything"
    • Analysis: This change also enhances grammatical structure and clarity, making the instruction more user-friendly.

Quality Assessment

Positive Aspects

  • ✅ The grammatical corrections significantly enhance the readability and professionalism of the text.
  • ✅ Consistent formatting with JSON conventions has been maintained throughout the changes.
  • ✅ The modifications improve clarity while preserving the original meaning.

Suggestions for Additional Improvements

  1. Consistency in Punctuation

    • It is advisable to consider adding periods at the end of the sentences within the prompt strings for better readability. For example:
    {
      "tools": {
        "delegate_work": "Delegate a specific task to one of the following coworkers: {coworkers}. The input to this tool should be the coworker, the task you want them to do, and ALL necessary context to execute the task. They know nothing about the task, so share absolutely everything you know. Don't reference things but instead explain them.",
        "ask_question": "Ask a specific question to one of the following coworkers: {coworkers}. The input to this tool should be the coworker, the question you have for them, and ALL necessary context to ask the question properly. They know nothing about the question, so share absolutely everything you know. Don't reference things but instead explain them."
      }
    }   
  2. Formatting Improvement

    • For better maintainability, breaking down long strings into multiple lines is recommended:
    {
      "tools": {
        "delegate_work": [
          "Delegate a specific task to one of the following coworkers: {coworkers}.",
          "The input to this tool should be the coworker, the task you want them to do,",
          "and ALL necessary context to execute the task. They know nothing about the task,",
          "so share absolutely everything you know. Don't reference things but instead explain them."
        ].join("\n"),
        "ask_question": [
          "Ask a specific question to one of the following coworkers: {coworkers}.",
          "The input to this tool should be the coworker, the question you have for them,",
          "and ALL necessary context to ask the question properly. They know nothing about the question,",
          "so share absolutely everything you know. Don't reference things but instead explain them."
        ].join("\n")
      }
    }

Conclusion

The pull request effectively resolves grammatical issues in the translation strings, resulting in clearer and more polished prompts. Implementing the suggested improvements would further enhance the translation file's clarity and maintainability.

Recommendation

Approve with suggestions
The core changes are accurate and enhance the text's overall quality. Additional suggestions are non-blocking but would improve the structure and clarity if addressed in a follow-up PR.


This review serves to acknowledge the crucial improvements made while providing actionable suggestions for further enhancement. Thank you for your contribution!

Copy link
Collaborator

@bhancockio bhancockio left a comment

Choose a reason for hiding this comment

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

Thank you for this improvement @RealVidy !

Verified

This commit was signed with the committer’s verified signature.
hawkw Eliza Weisman
@bhancockio bhancockio merged commit 3d4a1e4 into crewAIInc:main Feb 25, 2025
4 checks passed
bhancockio added a commit that referenced this pull request Feb 27, 2025

Verified

This commit was signed with the committer’s verified signature.
hawkw Eliza Weisman
Co-authored-by: Brandon Hancock (bhancock_ai) <109994880+bhancockio@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants