Skip to content

Added NPM to Glossary and linked to mentions - #7283

Merged
sklam merged 3 commits into
numba:masterfrom
nihalshetty-boop:NPM-Definition-and-Links
Aug 9, 2021
Merged

sklam merged 3 commits into
numba:masterfrom
nihalshetty-boop:NPM-Definition-and-Links

Conversation

@nihalshetty-boop

Copy link
Copy Markdown
Contributor

Reference an existing issue

Fixes #7282

Description

I've added NPM to the definition of nopython mode in glossary.rst. Also linked mentions of NPM in three places, having five occurences in total. Thanks a lot to @HPLegion and @stuartarchibald for helping me with this issue!

@stuartarchibald

Copy link
Copy Markdown
Contributor

Thanks for the patch @nihalshetty-boop, it's queued for review.

@stuartarchibald stuartarchibald added this to the Numba 0.55 RC milestone Aug 5, 2021
@HPLegion

HPLegion commented Aug 5, 2021

Copy link
Copy Markdown
Contributor

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 stuartarchibald left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the patch. I think the proposed changes look good, but please could the lines be wrapped to 80 chars? Many thanks.

@stuartarchibald stuartarchibald added 4 - Waiting on author Waiting for author to respond to review and removed 3 - Ready for Review labels Aug 5, 2021
@nihalshetty-boop

nihalshetty-boop commented Aug 5, 2021 •

Copy link
Copy Markdown
Contributor Author

but please could the lines be wrapped to 80 chars?

@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?

@nihalshetty-boop

Copy link
Copy Markdown
Contributor Author

but please could the lines be wrapped to 80 chars?

@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 Wrapped Line Characters to <= 80.

Comment thread docs/source/developer/numba-runtime.rst Outdated
* 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 :-)

@HPLegion

HPLegion commented Aug 6, 2021

Copy link
Copy Markdown
Contributor

(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)

@nihalshetty-boop

nihalshetty-boop commented Aug 6, 2021 •

Copy link
Copy Markdown
Contributor Author

@HPLegion Great, thank you for helping me out, I've corrected the indentation now :)

@HPLegion HPLegion left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me.

  • I have manually verified that the new NPM cross 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.

@nihalshetty-boop

Copy link
Copy Markdown
Contributor Author

@HPLegion Awesome! If an issue could be raised about

There are a couple of cosmetic changes that could be made to this file (line length violations, double spaces)

I would be interested in working on it. I'm not sure if I can raise issues as a first time contributor.

@HPLegion

HPLegion commented Aug 6, 2021 •

Copy link
Copy Markdown
Contributor

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 :-)
For a maintenance issue like this, where you already know what the problem is, an issue is probably not even needed. You can just fix it and make a PR explaining what you did and why (in my opinion).

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 ;-)

@nihalshetty-boop

Copy link
Copy Markdown
Contributor Author

Yes, it's better to wait till this PR has been merged 👍

@stuartarchibald

Copy link
Copy Markdown
Contributor

@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 stuartarchibald left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the patch.

@stuartarchibald

Copy link
Copy Markdown
Contributor

@nihalshetty-boop Congratulations on your first contribution to Numba!

@stuartarchibald stuartarchibald added 5 - Ready to merge Review and testing done, is ready to merge and removed 4 - Waiting on author Waiting for author to respond to review labels Aug 6, 2021
@nihalshetty-boop

Copy link
Copy Markdown
Contributor Author

Thank you!

@sklam
sklam merged commit 78df851 into numba:master Aug 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5 - Ready to merge Review and testing done, is ready to merge Effort - short Short size effort needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG/DOC: Missing definition in docs

4 participants