Improve docstrings and tighten array type annotations - #30
Merged
Conversation
Rewrite and standardize docstrings across pyakima.py: clarify corner_model and ext options as enumerated lists, describe SplineCoeffs as a NamedTuple, and expand the non-finite y and helper-dispatch notes. Tighten AkimaSpline x/y annotations to NDArray[np.floating] and add type: ignore[arg-type] on the integer-input tests accordingly. Adjust the linear_vector_calls error message to use set notation. Co-Authored-By: Claude Opus 4.8 <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
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
pyakima/pyakima.py: enumerate thecorner_modelandextoptions as lists, describeSplineCoeffsas aNamedTuple, and expand the non-finiteybehavior and helper-dispatch notes.AkimaSplinex/yannotations toNDArray[np.floating]and add# type: ignore[arg-type]on the integer-input tests accordingly.linear_vector_callsvalidation error message to set notation{0, 1}.Test plan
🤖 Generated with Claude Code