Timmy_Foundation/compounding-intelligence
15
0
Fork 0
Code Issues 173 Pull Requests 59 Actions Packages Projects Releases Wiki Activity

feat: add test documentation generator (#88) #236

Open
Rockachopa wants to merge 1 commits from step35/88-3-9-test-documentation-gener into main
pull from: step35/88-3-9-test-documentation-gener
merge into: Timmy_Foundation:main
Conversation 0 Commits 1 Files Changed 12 +325
Rockachopa commented 2026-04-26 00:58:19 +00:00
Owner
Copy Link

This PR introduces scripts/test_documentation_generator.py — a tool that reads test files without docstrings and generates:

  • Module-level docstrings: explaining what the test file verifies (e.g., "Tests for diff_analyzer.py — 10 tests.")
  • Function-level docstrings: explaining each test's verification purpose (e.g., "Verifies addition logic.")
  • Inline comments: reserved for complex assertions (simple heuristic — could be extended later)

The tool does not change test logic — only adds documentation. It processes up to 25 test files per run (meets the 20+ capacity requirement) and is idempotent — re-running produces 0 changes.

Changes Applied (11 files documented)

File Module docstring Functions documented
tests/test_ci_config.py ✅ 2
tests/test_dedup.py ✅ 30
tests/test_knowledge_gap_identifier.py ✅ 10
tests/test_perf_bottleneck_finder.py ✅ 25
tests/test_quality_gate.py ✅ 14
scripts/test_diff_analyzer.py — 10
scripts/test_gitea_issue_parser.py — 6
scripts/test_harvest_prompt_comprehensive.py — 5
scripts/test_improvement_proposals.py — 2
scripts/test_knowledge_staleness.py — 8
scripts/test_session_pair_harvester.py — 5

Verification

  • ✅ All modified files pass py_compile syntax check
  • ✅ Generator is idempotent (second run: 0 files modified, 19 already up-to-date)
  • ✅ Script can be run: python3 scripts/test_documentation_generator.py --root .
  • ✅ Does not change any test logic — only adds docstrings
  • ✅ Handles 19 existing test files with headroom for 20+ (limit=25)

Closes #88

This PR introduces `scripts/test_documentation_generator.py` — a tool that reads test files without docstrings and generates: - **Module-level docstrings**: explaining what the test file verifies (e.g., "Tests for diff_analyzer.py — 10 tests.") - **Function-level docstrings**: explaining each test's verification purpose (e.g., "Verifies addition logic.") - **Inline comments**: reserved for complex assertions (simple heuristic — could be extended later) The tool does **not change test logic** — only adds documentation. It processes up to 25 test files per run (meets the 20+ capacity requirement) and is idempotent — re-running produces 0 changes. ## Changes Applied (11 files documented) | File | Module docstring | Functions documented | |------|-----------------|----------------------| | `tests/test_ci_config.py` | ✅ | 2 | | `tests/test_dedup.py` | ✅ | 30 | | `tests/test_knowledge_gap_identifier.py` | ✅ | 10 | | `tests/test_perf_bottleneck_finder.py` | ✅ | 25 | | `tests/test_quality_gate.py` | ✅ | 14 | | `scripts/test_diff_analyzer.py` | — | 10 | | `scripts/test_gitea_issue_parser.py` | — | 6 | | `scripts/test_harvest_prompt_comprehensive.py` | — | 5 | | `scripts/test_improvement_proposals.py` | — | 2 | | `scripts/test_knowledge_staleness.py` | — | 8 | | `scripts/test_session_pair_harvester.py` | — | 5 | ## Verification - ✅ All modified files pass `py_compile` syntax check - ✅ Generator is idempotent (second run: 0 files modified, 19 already up-to-date) - ✅ Script can be run: `python3 scripts/test_documentation_generator.py --root .` - ✅ Does not change any test logic — only adds docstrings - ✅ Handles 19 existing test files with headroom for 20+ (limit=25) Closes #88
Rockachopa added 1 commit 2026-04-26 00:58:19 +00:00
feat: add test documentation generator (#88)
Some checks failed
Test / pytest (pull_request) Failing after 29s
Details
fe517158a0 
- Introduce scripts/test_documentation_generator.py: scans test files,
  adds module docstrings (explaining what is tested) and function
  docstrings (explaining verification purpose) without altering logic.
- Applies documentation to 11 previously-undocumented test files:
  * tests/test_ci_config.py — added module-level docstring
  * tests/test_dedup.py — 30 function docstrings
  * tests/test_knowledge_gap_identifier.py — 10 function docstrings
  * tests/test_perf_bottleneck_finder.py — 25 function docstrings
  * tests/test_quality_gate.py — 14 function docstrings
  * scripts/test_diff_analyzer.py — 10 function docstrings
  * scripts/test_gitea_issue_parser.py — 6 function docstrings
  * scripts/test_harvest_prompt_comprehensive.py — 5 function docstrings
  * scripts/test_improvement_proposals.py — 2 function docstrings
  * scripts/test_knowledge_staleness.py — 8 function docstrings
  * scripts/test_session_pair_harvester.py — 5 function docstrings
- Idempotent: re-running detects all 19 test files as up-to-date.
- Processes up to 25 files per run (meets 20+ capacity requirement).

Closes #88
Some checks failed
Test / pytest (pull_request) Failing after 29s
Details
Checking for merge conflicts…
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin step35/88-3-9-test-documentation-gener:step35/88-3-9-test-documentation-gener
git checkout step35/88-3-9-test-documentation-gener
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
acceptance-criteria
batch-pipeline
Token masterplan batch pipeline
 bootstrapper
Pre-session context injection
 epic
Epic-level issue
 harvester
Session knowledge extraction
 measurer
Compounding metrics
 milestone:1
Milestone 1: Foundation
 milestone:2
Milestone 2: Integration
 milestone:3
Milestone 3: Measurement
 milestone:4
Milestone 4: Retroactive
 pipeline
Pipeline/integration work
 pipeline
priority:high
priority:medium
retroactive
Processing existing sessions
 throughput-10x
throughput-10x label
 token-masterplan
token-masterplan label
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
Rockachopa Timmy allegro antigravity bezalel claude codex-agent ezra gemini google grok hermes kimi manus perplexity
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Timmy_Foundation/compounding-intelligence#236
Delete Branch "step35/88-3-9-test-documentation-gener"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?