docs: add type hints and mathematical docstrings to ad_projector#495
Open
ritu3534 wants to merge 1 commit intoNNPDF:masterfrom
Open
docs: add type hints and mathematical docstrings to ad_projector#495ritu3534 wants to merge 1 commit intoNNPDF:masterfrom
ritu3534 wants to merge 1 commit intoNNPDF:masterfrom
Conversation
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
This PR adds structured Google-style docstrings and type hints to the ad_projector and ad_projectors functions in basis_rotation.py.
Changes
Added type hints (tuple, int, bool, np.ndarray) for better IDE support and type safety.
Included mathematical descriptions of the projection logic from flavor to evolution basis.
Verification
Verified locally using pytest in a WSL2/Ubuntu environment.
Result: All 4 tests in tests/eko/test_basis_rotation.py passed successfully.