-
Notifications
You must be signed in to change notification settings - Fork 871
Quantum types tutorial #1306
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
base: main
Are you sure you want to change the base?
Quantum types tutorial #1306
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
🔥 New notebook just dropped! @amir-naveh , @TomerGoldfriend — come check out this shiny new addition to our repo. |
1e3a850 to
d4e7fd5
Compare
| @@ -0,0 +1,725 @@ | |||
| { | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My high level comments:
- The exercises seem really good and helpful.
- We should more strictly stick to the model of: Tutorial is solely exercises (with links to user guide, hints and solutions).
- The diagrams you used to describe visually the different types look very helpful for users' understanding. I would keep them but not in the tutorial but in the user guide (and just make sure to add here links).
Do you think "workshop" is a more appropriate name to the exercises-only thing that I suggest here?
Also, I'm not sure we have to have identical structure for the user guide and workshop. I mean - maybe for explanation it is useful to have types separate from functions, but for hands on exercise it is more useful to mix them together (and just include good links to user guide).
Not sure about that, just pointing out the idea.
So, I'd say lets be more strict about the role of each documentation part (formal reference / user guide / workshop / docstring) but less strict about the unufied structure (let each part be structured in the most useful way for its purpose)
Reply via ReviewNB
| @@ -0,0 +1,725 @@ | |||
| { | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This content is to be covered in the user guide, and only be linked from the tutorial.
Reply via ReviewNB
| @@ -0,0 +1,725 @@ | |||
| { | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here also, these are good explainations, but they should be left in the user guide. here e only want excercises + hints and solutions
Reply via ReviewNB
| @@ -0,0 +1,725 @@ | |||
| { | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A general comment for smoother review: Let's try to keep each content paragraph in its own notebook cell, so that when I add a comment it is clear to which text it refers.
Learning checklist - Like.
Reply via ReviewNB
PR Description
Including a new tutorial on quantum types and variables.