docs: update return annotations to use ndarray instance notation in stats/range-by#8939
Conversation
Coverage Report
The above coverage report was generated for the changes in this PR. |
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
kgryte
left a comment
There was a problem hiding this comment.
LGTM after clean-up. Note that many of the annotations in the README were incorrect, especially with incorrect dimensionality. The dimensionality of the nested array in the return annotation should match the dimensionality of the ndarray.
|
Thanks @kgryte! Noted — I’ll make sure the README annotations and dimensionality are correct going forward. |
|
@Orthodox-64 Ideally, our doctest linter would catch when the dimensionality is incorrect. So it seems like there is a bug in our implementation. It correctly errors when dimensionality matches but values differ. Sigh. Another thing to look into. |
|
@kgryte Thanks for the clarification. Understood — this appears to be a doctest linter issue and something we should look into. Appreciate the note. |
Resolves None.
Description
This pull request:
stats/range-byRelated Issues
This pull request has the following related issues:
Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
{{TODO: add disclosure if applicable}}
@stdlib-js/reviewers