Skip to content

refactor: centralize primary command descriptions - #3048

Merged
IsmaelMartinez merged 3 commits into
The-PR-Agent:mainfrom
Ricky-7-Yan:fix/3039-command-descriptions
Sep 7, 2026
Merged

IsmaelMartinez merged 3 commits into
The-PR-Agent:mainfrom
Ricky-7-Yan:fix/3039-command-descriptions

Conversation

@Ricky-7-Yan

Copy link
Copy Markdown
Contributor

Summary

  • add one canonical description map for /describe, /review, and /improve
  • use those descriptions in the CLI, bot help, per-tool usage guides, and PR help table
  • replace duplicated README and tools-index summaries with links to the dedicated tool pages
  • add regression coverage for every runtime help surface

Testing

  • PYTHONPATH=. uv run pytest tests/unittest/test_command_descriptions.py tests/unittest/test_cli_plain_diff_mode.py tests/unittest/test_cli_config_branch.py -q (16 passed)
  • uv run ruff check pr_agent/command_descriptions.py pr_agent/cli.py pr_agent/servers/help.py pr_agent/tools/pr_help_message.py tests/unittest/test_command_descriptions.py
  • python -m py_compile pr_agent/command_descriptions.py pr_agent/cli.py pr_agent/servers/help.py pr_agent/tools/pr_help_message.py tests/unittest/test_command_descriptions.py
  • python -X utf8 -m mkdocs build -f docs/mkdocs.yml

Closes #3039

@IsmaelMartinez IsmaelMartinez left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for turning this round the same day, and for covering the usage guides, which I had not thought to ask for.

Verified rather than read: the map is genuinely the single source, all five new tests go red with the three consumers restored to main, and the suite is 3620 passed. The new wording does reach the CLI help, all three branches of the /help table, and the usage guides appended to published /describe, /review and /improve bodies.

One inline note on the tools index.

Comment thread docs/docs/tools/index.md Resolved

@IsmaelMartinez IsmaelMartinez left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for restoring the table verbatim and revalidating on top of it. The code side is done from my end.

I diffed the restored table against my suggestion byte for byte and it matches, the five tests still go red with the three consumers reverted to main, and the full suite is 3620 passed with today's main merged in. The improve overview also no longer renders "improving the PR.The tool", which was a pre-existing bug.

One thing left: #3039 names six places and docs/docs/tools/{describe,review,improve}.md are untouched, so merging auto-closes it while describe.md now disagrees with the help.py overview it used to match. Align those three here, or switch Closes to Refs and I will take them separately.

@qodo-code-review

qodo-code-review Bot commented Sep 6, 2026 •

Copy link
Copy Markdown
Contributor

Code Review by Qodo

Grey Divider

Sorry, something went wrong

We weren't able to complete the code review on our side. Please try again manually by commenting /agentic_review on this PR.

Grey Divider

Qodo Logo

@Ricky-7-Yan

Copy link
Copy Markdown
Contributor Author

Addressed the remaining #3039 scope in 331df8e: the Overview text in describe.md, review.md, and improve.md now uses the canonical descriptions verbatim. I also added a regression test that reads all three UTF-8 Markdown files, so future drift is caught alongside the runtime surfaces. Verification: 19 focused tests passed; Ruff check/format, diff check, and MkDocs build succeeded (only existing link/optional imaging dependency warnings).

@IsmaelMartinez IsmaelMartinez left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for closing the last gap. The three tool pages and the regression test now match the map, so #3039 can close with this.

@IsmaelMartinez
IsmaelMartinez merged commit 9274e65 into The-PR-Agent:main Sep 7, 2026
4 checks passed
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.

The /describe, /review and /improve descriptions are maintained in six places and disagree

2 participants