Add descriptive docstrings and full type annotations - #30
Merged
Conversation
Every function in valentbind/model.py and its test helpers now has a docstring describing its purpose, parameters, and return value, plus complete parameter/return type annotations. Tightened a few loose npt.ArrayLike annotations to jax.Array where the value is already a converted array by the point it's used, which is what ty needed to verify the arithmetic in Req_polyfc/Req_polyc/Req_solve.
3 tasks
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
1 participant
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
valentbind/model.py(Req_polyfc,Req_polyc,commonChecks,polyfc,Req_solve,polyc) a docstring describing what it does, its parameters, and its return value, and complete parameter/return type annotations.valentbind/test/test_model.py(genPerm,multinomial,polyfc2) and add one-line docstrings +-> Noneto the four test functions.npt.ArrayLikeannotations becamejax.Arraywhere the value is already a converted array by the point it's used — this is what a type checker needs to verify the arithmetic insideReq_polyfc/Req_polyc/Req_solve.Test plan
uv run ruff check ./uv run ruff format --check .passuvx ty check valentbindpasses with the new annotationsuv run pytest --cov=valentbind— 100% coverage, 4 passed