Skip to content

docs: add Refactoring Needed section to KNOWN_ISSUES.md#422

Merged
aallan merged 1 commit into
mainfrom
docs/refactoring-needed
Mar 29, 2026
Merged

docs: add Refactoring Needed section to KNOWN_ISSUES.md#422
aallan merged 1 commit into
mainfrom
docs/refactoring-needed

Conversation

@aallan

@aallan aallan commented Mar 29, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Owner

Summary

Adds a Refactoring Needed section to KNOWN_ISSUES.md documenting four compiler/test files that have grown too large. Files and GitHub issues were identified by a full codebase audit.

File Lines Issue
vera/wasm/calls.py 8,337 #418
tests/test_codegen.py 10,019 #419
tests/test_checker.py 5,522 #420
vera/codegen/api.py 2,228 #421

Also labels the three historical refactoring issues (#99, #100, #155) with the new refactor label.

No code changes — documentation only.

Closes

No issues closed — this PR files and tracks new issues rather than resolving them.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated known issues documentation with a new section detailing planned refactoring efforts linked to corresponding issue tracker entries for transparency and progress tracking.

@aallan
docs: add Refactoring Needed section to KNOWN_ISSUES.md
9b771b0 
Documents four files that need decomposition (#418–#421):
- vera/wasm/calls.py (8,337 lines)
- tests/test_codegen.py (10,019 lines)
- tests/test_checker.py (5,522 lines)
- vera/codegen/api.py (2,228 lines)

Co-Authored-By: Claude <noreply@anthropic.invalid>
@coderabbitai

coderabbitai Bot commented Mar 29, 2026 •
edited
Loading

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: f0ffc180-bb62-4480-bb03-a982f25881ef

📥 Commits

Reviewing files that changed from the base of the PR and between a05523b and 9b771b0.

📒 Files selected for processing (1)
  • KNOWN_ISSUES.md
📝 Walkthrough

Walkthrough

The pull request adds a "Refactoring needed" section to KNOWN_ISSUES.md, documenting four large Python compiler modules (vera/wasm/calls.py, tests/test_codegen.py, tests/test_checker.py, vera/codegen/api.py) that require internal decomposition into subsystem and feature-focused modules. Each file entry is linked to corresponding issue tracker references (#418–#421).

Changes

Cohort / File(s) Summary
Documentation: Known Issues Tracking
KNOWN_ISSUES.md		 Added "Refactoring needed" section documenting four large files requiring decomposition, with cross-references to issue tracker entries #418–#421.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely summarises the main change: adding a 'Refactoring Needed' section to KNOWN_ISSUES.md documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/refactoring-needed

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov

codecov Bot commented Mar 29, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.30%. Comparing base (a05523b) to head (9b771b0).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #422   +/-   ##
=======================================
  Coverage   90.30%   90.30%           
=======================================
  Files          49       49           
  Lines       19163    19163           
  Branches      220      220           
=======================================
  Hits        17306    17306           
  Misses       1853     1853           
  Partials        4        4
Flag Coverage Δ
javascript 50.56% <ø> (ø)
python 95.30% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@aallan aallan merged commit 98fefaa into main Mar 29, 2026
19 checks passed
@aallan aallan deleted the docs/refactoring-needed branch March 29, 2026 11:57
This was referenced Apr 16, 2026
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@aallan