Repository navigation
Added NPM to Glossary and linked to mentions - #7283
Conversation
|
Thanks for the patch @nihalshetty-boop, it's queued for review. |
|
Glad I could help :-) Rendered docs seem to behave as expected: https://numba--7283.org.readthedocs.build/en/7283/developer/numba-runtime.html?highlight=npm |
stuartarchibald
left a comment
There was a problem hiding this comment.
Thanks for the patch. I think the proposed changes look good, but please could the lines be wrapped to 80 chars? Many thanks.
@stuartarchibald I'm sorry I didn't quite understand, can you elaborate on this? Should I decrease the character count of the PR Description to 80 characters? |
Understood the issue and fixed in commit |
| * numba NPM code references statically compiled code in "helperlib.c". Those | ||
| functions should be moved to NRT. | ||
| * numba :term:`NPM` code references statically compiled code in "helperlib.c". | ||
| Those functions should be moved to NRT. |
There was a problem hiding this comment.
When you fixed the line wrapping here, you accidentally broke the indentation. That is why one of the tests failed. (You can also see the effect of this by watching the "Github rendered" version or the read the docs build).
I suggest you click your way through the failed test pipeline to see how the output can help with finding what's broken :-)
|
(Right now the latest round of failed tests is shown in the bottom because you have not pushed any new commits yet. In general you can inspect previous test runs by clicking on the small red cross ❌ or green check mark ✔️ next to the fingerprint of the commit) |
|
@HPLegion Great, thank you for helping me out, I've corrected the indentation now :) |
HPLegion
left a comment
There was a problem hiding this comment.
This looks good to me.
- I have manually verified that the new
NPMcross references are working on ReadTheDocs. - The indentation error is fixed and the respective part now renders correctly
There are a couple of cosmetic changes that could be made to this file (line length violations, double spaces) But in my eyes they are not really a part of this PR, so I would personally avoid mixing them in here.
|
@HPLegion Awesome! If an issue could be raised about
I would be interested in working on it. I'm not sure if I can raise issues as a first time contributor. |
Anyone can - and should - open issues if they see any :-) That said, I'd wait for feedback from a core maintainer here, to see how they feel about this. Maybe they actually prefer if those changes are integrated here. Secondly, if you start working on this now, before this PR is merged into master, then you will likely run into merge conflicts with your cosmetics branch later, because some of the changes will touch on the same lines as this PR. If you see that as an annoyance or as a possibility to learn dealing with conflicts, is up to you to decide ;-) |
|
Yes, it's better to wait till this PR has been merged 👍 |
|
@HPLegion many thanks for providing guidance throughout this PR and for reviewing it, it's much appreciated. @nihalshetty-boop, @HPLegion , I'd say it's fine to just open PRs for cosmetic fixes to e.g. docs that are quick to do and unlikely to be controversial. It's entirely fine to open PRs for anything, but obviously if there's a lot of work involved it's generally a good idea to open an issue about it first so as to gather feedback prior to starting the work to ensure that the PR has a good chance of being merged etc. RE additional changes. To save merge conflict issues I'd either wait for this PR to be merged (probably in the merge window later today) or to base a new PR off this branch and then when this patch is merged git/github will just figure out the diff. |
stuartarchibald
left a comment
There was a problem hiding this comment.
Thanks for the patch.
|
@nihalshetty-boop Congratulations on your first contribution to Numba! |
|
Thank you! |
Reference an existing issue
Fixes #7282Description
I've added
NPMto the definition of nopython mode inglossary.rst. Also linked mentions ofNPMin three places, having five occurences in total. Thanks a lot to @HPLegion and @stuartarchibald for helping me with this issue!