Skip to content

docs: improve test suite documentation - #2

Merged
man4ish merged 1 commit into
mainfrom
docs/test-suite-docstrings
Sep 18, 2026
Merged

man4ish merged 1 commit into
mainfrom
docs/test-suite-docstrings

Conversation

@man4ish

@man4ish man4ish commented Sep 18, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a file-level JSDoc header and a one-line comment above each it() across the component test suite (11 .test.tsx files), plus a short header on src/test-setup.ts.
  • Coverage: 12/12 files documented, 65/65 it() blocks documented, attribution (Developer: Manish Kumar <manish@omnibioai.org>) on 12/12 files.
  • This repo is TypeScript/Vitest rather than Python/pytest, so the approach differs from the org's Python test-docstring standard: JSDoc file headers + per-test line comments in place of module/test docstrings, and a TypeScript-compiler-API AST-equivalence check in place of Python's ast module.

Documentation only

  • Executable AST differences vs main: 0 across all 12 files, verified with a script using the TypeScript compiler API (ts.createSourceFile) that strips all comments/trivia and compares the structural node stream. Validated first on a throwaway comment-only edit (0 diffs) and a throwaway real code edit (correctly flagged), before trusting it on the actual files.
  • No component source, config, or build files changed. Only the 11 test files and test-setup.ts are touched (+138/−0, additions only).

Test plan

  • tsc --noEmit: clean before and after
  • vitest run: 65/65 passed before and after (identical)
  • Boilerplate audit: caught and fixed one duplicate comment (reworded to distinguish Input's field label from StatusDot's status label); 0 duplicates, 0 generic phrases remaining

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@man4ish
man4ish merged commit b60f2ec into main Sep 18, 2026
1 of 3 checks passed
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