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

tickets/SP-845 #229

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

tickets/SP-845 #229

wants to merge 2 commits into from

Conversation

ryanlauastro
Copy link
Contributor

DP0.2 Diaobject anomaly detection tutorial notebook

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@bnord
Copy link

bnord commented Feb 10, 2025

General

  1. “In order to” is a generally unnecessary phrase. It often feels better when we speak, but when written it can be replaced by “to.” Dealer’s choice, though.
  2. Consider avoiding single-letter variables, like “x,” because those can easily be misunderstood by the user, or duplicated in a notebook, causing confusion by overwriting variables from another cell.
  3. “I.e.” and “e.g.” always require a comma following them.
  4. Consider changing the prose to avoid “In the following cell.” Consider writing the markdown such that it gives instruction. For example, “Next, make an array that blah blah.” This might make the text a bit more direct and easier to follow.
  5. Pycodestyle violations remain to be addressed throughout notebook
  6. Consider adding a top-level outline in list form or in prose form to help the user know what to expect as they navigate the notebook.

Copy link

@bnord bnord left a comment

Choose a reason for hiding this comment

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

Comments are posted in the 'conversation'. I'm ready to review changes whenever ready.

Updating to address Brian's feedback.
@ryanlauastro
Copy link
Contributor Author

Hi @bnord, alright, just updated the notebook and it should be ready for a follow up review.

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

Successfully merging this pull request may close these issues.

2 participants