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

Updating Demo Notebooks for How-to-Guides #237

Merged
merged 5 commits into from Dec 9, 2021
Merged

Updating Demo Notebooks for How-to-Guides #237

merged 5 commits into from Dec 9, 2021

Conversation

shir22
Copy link
Contributor

@shir22 shir22 commented Dec 8, 2021

also deleted a few redundant old notebooks

@shir22 shir22 added the documentation modification of the documentation / readme's label Dec 8, 2021
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@shir22 shir22 requested a review from matanper December 8, 2021 18:42
@@ -0,0 +1,759 @@
{
Copy link
Contributor

Choose a reason for hiding this comment

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

Is that the place to mention the option of "start with predefined suite and slightly modify it to your needs"?


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can we remove & add checks to built-in suites?

If so I think we should add that, but also a part that describes how to do that.

Copy link
Contributor

Choose a reason for hiding this comment

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

yes it's possible

Copy link
Contributor Author

@shir22 shir22 Dec 8, 2021

Choose a reason for hiding this comment

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

Ok so I'll add a short description, with a TODO for the example which we'll fill in tomorrow

@@ -0,0 +1,759 @@
{
Copy link
Contributor

@matanper matanper Dec 8, 2021

Choose a reason for hiding this comment

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

I don't think this is something we want to encourage to do... better to just directly refer to the API ref


Reply via ReviewNB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes this was written before we had it. and then I thought it's kind of convenient.

but will delete :)

@@ -0,0 +1,759 @@
{
Copy link
Contributor

@matanper matanper Dec 8, 2021

Choose a reason for hiding this comment

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

I think that it's better to put the imports with the code for copy & paste simplicity.

also I'd add after the definition a print of the suite


Reply via ReviewNB

@@ -0,0 +1,2112 @@
{
Copy link
Contributor

Choose a reason for hiding this comment

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

"This notebook" -> "This guide/documentation"


Reply via ReviewNB

@@ -0,0 +1,2112 @@
{
Copy link
Contributor

@matanper matanper Dec 8, 2021

Choose a reason for hiding this comment

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

all this 4 blocks of code preparations are mostly noise, if possible I'd put them in a single cell, even a collapsed one if possible, as I don't think most users will care to see this.


Reply via ReviewNB

Copy link
Member

@ItayGabbay ItayGabbay left a comment

Choose a reason for hiding this comment

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

Looks good to me. I wish we would solve the autocomplete part. (Maybe recommend users to use JupyterLab?)

@shir22 shir22 merged commit db287cf into main Dec 9, 2021
@delete-merged-branch delete-merged-branch bot deleted the update-quickstart branch December 9, 2021 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation modification of the documentation / readme's
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants