Skip to content

test: name guarding PRs in regression-test docstrings#333

Merged
xdotli merged 2 commits into
mainfrom
fix/regression-test-docstrings
May 21, 2026
Merged

test: name guarding PRs in regression-test docstrings#333
xdotli merged 2 commits into
mainfrom
fix/regression-test-docstrings

Conversation

@xdotli
Copy link
Copy Markdown
Member

@xdotli xdotli commented May 21, 2026

Summary

AGENTS.md requires: "Regression tests must name the PR/commit they guard in the docstring (e.g. Guards the fix from PR #198 against the regression introduced by PR #193)."

The review bots (Codex P1 / Devin) flagged this convention violation repeatedly across PRs #308, #309, #319, #320, #327, and #329 — the regression tests added there cited only a GitHub issue (Guards issue #NNN), an audit finding, or no reference at all, instead of naming the guarding PR.

This is a docstring-only, behavior-preserving change. No test logic or assertions were touched. Existing issue/finding references are kept alongside the new PR reference.

Docstrings fixed

Verification

  • uv run ruff format --check src tests — passes
  • uv run ruff check . — passes
  • uv run ty check src/ — passes
  • uv run python -m pytest tests/ — 1310 passed, 27 skipped (unchanged; docstring-only)

Open in Devin Review

Note

Low Risk
Low risk: docstring-only edits in test files with no behavioral or assertion changes.

Overview
Aligns regression-test docstrings with AGENTS.md by adding explicit “Guards the fix from PR #…“ references (while keeping existing issue/audit identifiers) across several test modules.

No test logic, assertions, or production code is modified; only docstring wording/formatting is updated.

Reviewed by Cursor Bugbot for commit 9539002. Bugbot is set up for automated code reviews on this repo. Configure here.

xdotli added 2 commits May 21, 2026 18:12
AGENTS.md requires regression tests to name the PR/commit they guard in
the docstring. Several regression tests added in recent PRs cited only a
GitHub issue (or an audit finding) without the guarding PR. Update the
docstrings to follow the AGENTS.md convention, keeping the existing
issue/finding references.

Fixes review-bot comments repeated across PRs #308, #309, #319, #320,
#327, #329.
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

Open in Devin Review

@xdotli xdotli merged commit bbd8995 into main May 21, 2026
3 checks passed
@xdotli xdotli deleted the fix/regression-test-docstrings branch May 22, 2026 14:57
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.

1 participant