Disallow k=None for the eye function
#278
Merged
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
|
This looks good to me, but others should confirm that this is indeed what was intended. |
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.
Xref #143 and numpy/numpy#19969.
The spec currently claims that the
kparameter ofeyeshould accept eitherNoneor an integer, however not a single mention is made ofNonein the actual parameter-description. In fact, support fork=Noneseems to be absent from the limes ofnp.eyeas well.Based on this it seems the inclusion of the
k: Optional[int] = ...annotation may have been accidental; hence theOptionalencapsulation is removed in this PR. If this was a deliberate choice I'd instead propose to update the docs with a more explicit mention ofNoneand its expected behavior.