docs: improve test suite documentation - #4
Merged
Merged
Conversation
Add module docstrings, per-test docstrings and developer attribution across tests/, documenting the precise behavior each test exercises. Documentation only: no executable test semantics changed (verified via AST comparison against the pre-change baseline for every modified file). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Developer: Manish Kumar <manish@omnibioai.org>attribution to all 21 test modules undertests/(including the previously emptytests/__init__.pyandtests/conftest.py).test_*functions (130 were undocumented), each stating the specific behavior the test asserts. Documents all 12 fixtures and 12 helpers. Existing docstrings are preserved verbatim.Verification
git diff --checkis clean and only files undertests/changed.Notes for reviewers
app/main.pyrunsBase.metadata.create_allat import against a MySQL host, so all test runs used a scratch pytest plugin that blocks non-local socket connections and counts attempts: 0 attempts, and no live infrastructure was touched..sofiles next to their.pysources; the*_sourcetests load the.pyfiles directly viatests/_srcload.py, and the docstrings describe that source behavior.roleslist in the request body; the docstrings say "roles supplied in the request" and make no authentication claim.test_queries_correct_user_idonly asserts that theUsageRecordtable is queried, not the user id. It is documented by what it asserts and left unchanged.🤖 Generated with Claude Code