Skip to content

Refer to the Log Checks Without Counting Them - #1237

Merged
ptr727 merged 1 commit into
developfrom
feature/readme-check-count
Nov 9, 2026
Merged

ptr727 merged 1 commit into
developfrom
feature/readme-check-count

Conversation

@ptr727

@ptr727 ptr727 commented Nov 9, 2026

Copy link
Copy Markdown
Owner

Summary

Review on the promotion pull request #1234 flagged a stated count in RegressionTests/README.md "Comparing two runs": "for two further checks". A count of a list is a second copy that nothing keeps in sync with the list. So the sentence refers to the checks below it instead of counting them.

Test plan

  • prose_lint.py --diff origin/develop, markdownlint, and cspell: clean.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings November 9, 2026 20:49
@ptr727

ptr727 commented Nov 9, 2026

Copy link
Copy Markdown
Owner Author

A recorded local strict-review pass covers head 9ac12d5aa0adcc809f4b3c8dfacf58ff79300dad, the content this pull request carries at that commit against develop, and it recorded 0 findings.

@coderabbitai

coderabbitai Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

Explain Change →

Caution

Review failed

The pull request is closed.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can see how risky a PR is at a glance with blast radius labels

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Remove Hard-Coded Check Count from Regression Test README

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Replace the stated count of log checks with a reference to the list below.
• Keep the introduction accurate if checks are added or removed.
High-Level Assessment

Referring to the list directly is the simplest way to avoid maintaining a separate count; no architectural alternative is warranted.

Files changed (1) +1 / -1

Documentation (1) +1 / -1
README.mdRefer to log checks without stating their count +1/-1

Refer to log checks without stating their count

• The comparison instructions now point to the checks listed below instead of saying there are two. This prevents the introduction from becoming inaccurate if the list changes.

RegressionTests/README.md

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues remain, and the documentation change is narrowly scoped to removing a potentially drifting hard-coded count while leaving the referenced checks unchanged.

No open issues 🎉

What changed in this PR

This small documentation PR removes a hard-coded count from RegressionTests/README.md. The "Comparing two runs" section said "for two further checks", but that count can drift from the list under it. The sentence now points to "the further checks below", so the list is the only place that describes the checks.

Changes:

  • Replaces "for two further checks:" with "for the further checks below:" in the "Comparing two runs" section.
  • Leaves the two checks below it (output tracks and normalized log lines) unchanged.
File Description
RegressionTests/​README.md Removes the stated count of checks so the sentence refers to the list below instead of duplicating it.

Review effort: Lite

@ptr727

ptr727 commented Nov 9, 2026

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Action not completed

Pull request is closed.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@ptr727
ptr727 merged commit d107e7b into develop Nov 9, 2026
16 checks passed
@ptr727
ptr727 deleted the feature/readme-check-count branch November 9, 2026 20:52
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.

2 participants