Skip to content

chore: ruff-format the source + drop stale STUB/TODO docstrings#5

Merged
mabry1985 merged 1 commit into
mainfrom
chore/format-and-stale-docstrings
Jun 13, 2026
Merged

chore: ruff-format the source + drop stale STUB/TODO docstrings#5
mabry1985 merged 1 commit into
mainfrom
chore/format-and-stale-docstrings

Conversation

@mabry1985

Copy link
Copy Markdown
Member

What

The cleanup follow-up to the test-suite PR (#4).

  1. ruff format the whole source. The suite's CI already format-checked tests/; this normalizes the source too (it predated a format pass) and broadens the CI step back to ruff format --check .. Pure whitespace — no behaviour change; the 61 tests stay green.

  2. Drop stale STUB/TODO docstrings that described work which has since landed:

    • api.py: remove the "webhook HMAC is a TODO" STUB note (HMAC verification is implemented in _webhook_pr) and the "Poll is the fallback" line (there is no poll — the merge webhook is the only Done edge); fix the /ci comment that pointed at the now-removed TODO.
    • loop.py: remove the "STUBBED for review / open_pr is sketched" note (open_pr is fully implemented in worktree.py); keep the accurate concurrency-cap note.
    • board_view.py: "deferred-until-now UI" → "the Kanban/list board UI".

Verification

  • ruff check . — clean
  • ruff format --check . — 13 files already formatted
  • pytest -q — 61 passed

🤖 Generated with Claude Code

Normalize every source file with `ruff format` (the test suite + CI already
enforced this on tests/; now the whole repo is clean) and broaden the CI
format-check back to the whole repo. Pure whitespace — no behaviour change;
the 61 tests stay green.

Also correct docstrings/comments that described unfinished work that has since
landed:
- api.py: drop the "webhook HMAC is a TODO" STUB note (HMAC verification is
  implemented) and the "Poll is the fallback" line (there is no poll — the merge
  webhook is the only Done edge); fix the /ci comment that pointed at the removed
  TODO.
- loop.py: drop the "STUBBED for review / open_pr is sketched" note (open_pr is
  fully implemented); keep the accurate concurrency-cap note.
- board_view.py: "deferred-until-now UI" -> "the Kanban/list board UI".

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@protoquinn

protoquinn Bot commented Jun 13, 2026

Copy link
Copy Markdown

👀 Quinn is reviewing — verdict (PASS / WARN / FAIL) + findings to follow.

@mabry1985
mabry1985 merged commit 406bbf2 into main Jun 13, 2026
1 check passed

@protoquinn protoquinn Bot 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.

QA Audit — PR #5 | chore: ruff-format the source + drop stale STUB/TODO docstrings

VERDICT: WARN (CI non-terminal — test: queued)


CI Status

  • test: queued ⏳

Diff Review

  • .github/workflows/ci.yml: expands ruff format --check from tests/ to . — intentional, the source is now formatted (13 files already pass per PR body). No behavioral change.
  • __init__.py, api.py, loop.py, board_view.py: ruff format pass — pure whitespace/line-break reflow. No logic altered.
  • api.py docstring: stale STUB note about HMAC being TODO replaced with accurate description of existing _webhook_pr HMAC verification. Correct.
  • api.py /ci comment: stale TODO reference removed. Clean.

Observations

  • LOW: clawpatch structural review unavailable — repo not in project registry. Proceeding on diff review alone; this PR is formatting-only so structural depth wouldn't add signal.
  • No blocking findings. Docstring removals are accurate and well-scoped. Formatting is ruff-consistent. Awaiting terminal CI for formal PASS.

— Quinn, QA Engineer

@protoquinn

protoquinn Bot commented Jun 13, 2026

Copy link
Copy Markdown

Submitted COMMENT review on protoLabsAI/projectBoard-plugin#5.

@mabry1985
mabry1985 deleted the chore/format-and-stale-docstrings branch June 13, 2026 04:40
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