AGENTS: Avoid parrot comment

[patrickelectric]

Summary by Sourcery

Documentation:

• Document that parrot comments are discouraged in agent-related code guidelines.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Clarifies the AGENTS coding guidelines by explicitly discouraging parrot comments in the comments section of the style guide.

File-Level Changes

Change	Details	Files
Update coding guidelines to explicitly prohibit parrot comments in code comments.	Add a new bullet under the "When writing code" section specifying not to write parrot comments Keep surrounding guidance on comments and refactoring unchanged for context	AGENTS.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've left some high level feedback:

• Consider briefly clarifying what is meant by 'parrot comments' (e.g., an example or short definition) so that new contributors unfamiliar with the term can interpret the guideline consistently.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Consider briefly clarifying what is meant by 'parrot comments' (e.g., an example or short definition) so that new contributors unfamiliar with the term can interpret the guideline consistently.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[joaoantoniocardoso]

"parrot comments" 🤣