DOC: Make input/output type consistent and add more examples for documentation #23611
Conversation
This file contains 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
|
Wonder if anyone knows how to fix the failed tests related to old_gcc and armv7_simd_test? Thanks in advance! |
rossbar
reviewed
Apr 20, 2023
There was a problem hiding this comment.
There's no need for the updated parameter descriptions, array_like encompasses scalars.
|
Got it! Thanks for the explanation. It looks like sometimes the input type uses "array_like" but output type uses "ndarray or scalar", I think that's what caused the confusion. I can update to make them consistent! |
Sarah-Yifei-Wang
changed the title
rossbar
reviewed
Apr 29, 2023
mdhaber
reviewed
Dec 31, 2023
[skip cirrus] [skip azp] [skip actions]
mdhaber
approved these changes
Dec 31, 2023
There was a problem hiding this comment.
The examples in which the output is a scalar LGTM. I'll go ahead and merge if CI looks good. Thanks @Sarah-Yifei-Wang.
[skip actions] [skip azp] [skip cirrus]
[skip azp] [skip actions] [skip cirrus]
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.
I noticed in quite a few scimath function, the input type is array_like, but output type is ndarray or scalar. Initially this caused some confusion for me, making me feel input does not contain scale. To avoid future confusion, this PR is to: