New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: cross2d wrong doc. reference (issue #6276) #6277
Conversation
See issue numba#6276 for more details
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the patch. Think it'd be a good idea to update the unit tests too to make sure it's less likely to happen again. Suggest updating the import here to reflect the public API location:
numba/numba/tests/test_np_functions.py
Line 18 in db74d8f
from numba.np.arraymath import cross2d |
and then checking the correct path is in the error string here:
numba/numba/tests/test_np_functions.py
Lines 3589 to 3592 in db74d8f
self.assertIn( | |
'Dimensions for both inputs is 2', | |
str(raises.exception) | |
) |
Thanks!!
CHANGE_LOG
Outdated
@@ -1199,7 +1199,7 @@ Enhancements from user contributed PRs (with thanks!): | |||
* Lucio Fernandez-Arjona extended Numba's ``np.sum`` support to now accept the | |||
``dtype`` kwarg in #4472. | |||
* Pedro A. Morales Maries added support for ``np.cross`` in #4128 and also added | |||
the necessary extension ``numba.numpy_extensions.cross2d`` in #4595. | |||
the necessary extension ``numba.np.extensions.cross2d`` in #4595. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As the change log is a reflection of history I don't think that this should be changed, irrespective of this being in the wrong place for current Numba.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok my bad, I was doubtful about changing this but thank you for the information
Yes indeed, thank you for noticing @stuartarchibald . I did update the code. I ran the test and it seems ok:
|
Co-authored-by: stuartarchibald <stuartarchibald@users.noreply.github.com>
as mentionned, it is preferable to keep changelog, even if it contained errors
@jeertmans thanks for addressing the issue comments. From what I understand, @stuartarchibald suggested to add a check for the correct error string to the unit test. Something like:
To double check that the path listed in the error message is indeed the correct one. |
Thanks for the explanation @esc ! I did commit an additional check for that purpose. I hope it follows your standards. |
@jeertmans excellent, thank you very much! I'll mark it as Ready to Merge under the assumption that @stuartarchibald will agree. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the patch and fixes.
@jeertmans Congratulations on your first contribution to Numba! |
Thank you both @stuartarchibald and @esc , I appreciate your help and I hope to be able to contribute more :) |
See issue #6276 for more details
Closes #6276