Skip to content
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

Consider using ReviewNB for notebook code reviews #292

Open
AdamRJensen opened this issue Sep 16, 2021 · 1 comment
Open

Consider using ReviewNB for notebook code reviews #292

AdamRJensen opened this issue Sep 16, 2021 · 1 comment

Comments

@AdamRJensen
Copy link

Jupyter Notebooks are great for documentation, however, reviewing code in notebooks is a pain and often requires reviewing changes locally.

Since the rdtools documentation is written mainly in notebooks I think it's worth considering using the ReviewNB GitHub app. ReviewNB integrates into the GitHub PR discussion flow and gives the option to view the new and old versions of the notebook side by side with changes highlighted. It is possible to add comments to specific notebook cells, which then show up in the PR discussion.

It's free for open-source projects and very easy to get started with, so if anything I would recommend trying it out for a short period to see if it adds value to the project.

You can check out an example PR with a single review here, where the interface looks like this:
image

@kandersolar
Copy link
Member

kandersolar commented Sep 16, 2021

Thanks @AdamRJensen for the suggestion!

Note that this is different from, and maybe complementary to, #270. This is for diffing notebook content whereas #270 is for checking that the new notebook runs correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants