Lecture Review: Major Restructuring of Advanced Python Programming Section, Task 2-3 by HumphreyYang · Pull Request #218 · QuantEcon/lecture-python-programming

HumphreyYang · 2022-09-10T12:53:51Z

Hi @jstac and @mmcky,

I finished task 2 and task 3 of #210.

Here is a summary of what I have done:

Restructure:
- moved the discussion on errors and exceptions to chapter 17. Debugging and renamed it to 17. Debugging and Errors
- moved the discussion on the namespace to 6. OOP I: Introduction to Object Oriented Programming
- moved the corresponding exercise on exceptions to 17.4. Exercises
Additions:
- I wrote an exercise for the namespace in 6.5. Exercises
- I added namespace into the summary section 6.4. Summary
- I added necessary transitions between sections.

Please kindly review these changes, and let me know if there is anything I need to change.

About moving Advanced Python Programming to Introduction to Python
- As we have discussed before @jstac in previous meeting, we might be able to move the three lectures under Advanced Python Programming to Introduction to Python. However, during the review, I found a lot of knowledge involved in lectures under Advanced Python Programming is discussed in the scientific library lectures. For example, the lecture on debugging involves some levels of understanding of np.array and matplotlib.pyplot.subplots (see this section). Therefore, for the sake of clarity, it may be better if we leave the entire structure unchanged, or we can rewrite some of them without assumed knowledge.

Could you also give your suggestions on this issue?

Many thanks in advance.

jstac · 2022-09-13T15:16:09Z

lectures/debugging.md

+```{index} single: Python; Handling Errors
+```
+
+Errors are problems within a program that stops the program from running further.


"stops" -> "stop"

Is this true? If they are caught in a try-except block, then execution continues?

jstac · 2022-09-13T15:28:33Z

Perhaps we should change the title "OOP I: Introduction to Object Oriented Programming" to "OOP I: Names and Objects"

jstac · 2022-09-13T15:30:08Z

"Every object is bound by its name"

Is this statement true? What about anonymous functions?

How about "Zero, one or many names can be bound to a given object" ?

jstac · 2022-09-13T15:31:06Z

it may be better if we leave the entire structure unchanged, or we can rewrite some of them without reassumed knowledge.

Thanks for the thoughtful recommendation. Let's do as you say. Please see the comments above.

jstac · 2022-09-19T19:34:52Z

Thanks @HumphreyYang .

@mmcky , would you mind to help review this PR? Another set of eyes would be very helpful.

PS I can't see an active deployment above --- I might be missing it.

mmcky · 2022-09-19T23:52:56Z

Thanks @HumphreyYang .

@mmcky , would you mind to help review this PR? Another set of eyes would be very helpful.

PS I can't see an active deployment above --- I might be missing it.

Thanks @HumphreyYang once you have made updates re: @jstac comments above - please tag me as a reviewer and I will do a second round review.

@jstac they seem less obvious these days. You can click on Netlify and Details to see the deployment at the bottom of the GitHub Actions window.

HumphreyYang · 2022-09-20T00:52:52Z

Thanks @HumphreyYang .
@mmcky , would you mind to help review this PR? Another set of eyes would be very helpful.
PS I can't see an active deployment above --- I might be missing it.

Thanks @HumphreyYang once you have made updates re: @jstac comments above - please tag me as a reviewer and I will do a second round review.

@jstac they seem less obvious these days. You can click on Netlify and Details to see the deployment at the bottom of the GitHub Actions window.

Hi @mmcky, I have updated the lecture based on the review, could you please have a look at the current version and check if there are any changes I need to make?

mmcky

Thanks @HumphreyYang I have added some inline suggestions and changes.

lectures/debugging.md

lectures/oop_intro.md

jstac · 2022-09-21T18:30:45Z

Thanks for collaborating @HumphreyYang and @mmcky .

Please ping me directly (put a comment with @jstac) when you are ready for me to review.

mmcky · 2022-09-22T23:48:25Z

@jstac I think this is ready for review

jstac · 2022-09-27T12:19:31Z

lectures/oop_intro.md

+If you just want to see the names, you can type
+
+```{code-cell} python3
+dir(math)[0:10]


Please add a comment # show the first 10 names

jstac · 2022-09-27T12:23:41Z

lectures/oop_intro.md

+* They have their own namespace called `__builtins__`.
+
+```{code-cell} python3
+dir()[0:10]


please add comment

# show the first 10 names in `__main__`

jstac · 2022-09-27T12:24:43Z

lectures/oop_intro.md

+```
+
+```{code-cell} python3
+dir(__builtins__)[0:10]


# show the first 10 names in `__builtins__`

jstac · 2022-09-27T12:41:46Z

Great work @HumphreyYang !

You've made some really big improvements here. I'm really pleased.

@mmcky , many thanks for the careful review and all those suggestions.

Just some very minor requests above. Also, in the lecture on debugging, could @HumphreyYang please mention that a visual debugger is available in JupyterLab: https://jupyterlab.readthedocs.io/en/stable/user/debugger.html

You might add it as a note, if you like.

(This is the best reason I've seen for switching to Jupyterlab. It seems they have been putting a lot of effort into the debugger.)

@HumphreyYang , could you please add those small comments above, plus the mention of the visual debugger, and then ping @mmcky so he can merge.

@mmcky , let's remember to tell @natashawatkins when this is published so that she can tweet the improvements.

HumphreyYang · 2022-09-28T01:30:26Z

Hi @mmcky,

Could you also have a look at the latest deployment here as well, and merge it if it looks good to you?

Many thanks!

mmcky · 2022-09-28T02:37:56Z

visual debugger is available in JupyterLab: https://jupyterlab.readthedocs.io/en/stable/user/debugger.html

Oh this looks good. @jstac in discussions with Rowan and the Curvenote team -- it looks like the jupyterlab myst extension is coming along nicely. this is another reason I think our switch is pretty imminent. I am starting to use it locally with the single notebook view.

mmcky · 2022-09-28T02:40:28Z

Thanks @jstac for review and @HumphreyYang for all your work on this. This looks great.

HumphreyYang added 8 commits September 10, 2022 14:44

update

018526b

restructure namespace

40edc4d

adding namespace to summary

5e480c7

add link for garbage collection

d183486

oop exercise

49ca6e3

add a label for boolean data type

aac0145

fix typos

1476ffe

change title

82256bc

HumphreyYang changed the title ~~Lecture Review: Restructuring Advanced Python Programming Section, Task 2-3~~ Lecture Review: Major Restructuring of Advanced Python Programming Section, Task 2-3 Sep 10, 2022

jstac reviewed Sep 13, 2022

View reviewed changes

HumphreyYang marked this pull request as draft September 14, 2022 10:51

HumphreyYang added 2 commits September 14, 2022 20:53

restructure debugging section

fe6d6b4

update oop_intro

3177b7d

HumphreyYang linked an issue Sep 14, 2022 that may be closed by this pull request

Restructuring Advanced Python Programming Section #210

Closed

3 tasks

github-actions bot temporarily deployed to commit September 14, 2022 11:13 Inactive

HumphreyYang added 3 commits September 17, 2022 22:18

add visualisations

f18e2a2

add images for each line

eb8badf

update debugging chapter

5fa94a1

github-actions bot temporarily deployed to commit September 17, 2022 12:54 Inactive

restructure intro to visualisation

6d3292a

github-actions bot temporarily deployed to commit September 17, 2022 13:35 Inactive

fix typos

4347cc1

HumphreyYang marked this pull request as ready for review September 17, 2022 13:38

github-actions bot temporarily deployed to commit September 17, 2022 13:47 Inactive

fix dash

8a1f8c1

github-actions bot temporarily deployed to commit September 17, 2022 14:01 Inactive

fix indent

0e4bece

HumphreyYang requested a review from mmcky September 20, 2022 00:01

mmcky reviewed Sep 20, 2022

View reviewed changes

HumphreyYang marked this pull request as draft September 21, 2022 05:36

integrate comments

4774cad

github-actions bot temporarily deployed to commit September 21, 2022 08:10 Inactive

show output

5f46161

github-actions bot temporarily deployed to commit September 21, 2022 09:53 Inactive

HumphreyYang marked this pull request as ready for review September 21, 2022 09:55

fix typo

4440f1d

github-actions bot temporarily deployed to commit September 22, 2022 05:56 Inactive

clarify comment

bd5be17

github-actions bot temporarily deployed to commit September 22, 2022 06:07 Inactive

HumphreyYang requested a review from mmcky September 22, 2022 06:44

mmcky approved these changes Sep 22, 2022

View reviewed changes

jstac reviewed Sep 27, 2022

View reviewed changes

update comments

6ca5fed

github-actions bot temporarily deployed to commit September 28, 2022 01:23 Inactive

mmcky merged commit ba924f5 into main Sep 28, 2022

mmcky deleted the restructure-advanced branch September 28, 2022 02:40

Uh oh!

Conversation

HumphreyYang commented Sep 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jstac Sep 13, 2022

Choose a reason for hiding this comment

Uh oh!

jstac commented Sep 13, 2022

Uh oh!

jstac commented Sep 13, 2022

Uh oh!

jstac commented Sep 13, 2022

Uh oh!

jstac commented Sep 19, 2022

Uh oh!

mmcky commented Sep 19, 2022

Uh oh!

HumphreyYang commented Sep 20, 2022

Uh oh!

mmcky left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jstac commented Sep 21, 2022

Uh oh!

mmcky commented Sep 22, 2022

Uh oh!

jstac Sep 27, 2022

Choose a reason for hiding this comment

Uh oh!

jstac Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jstac Sep 27, 2022

Choose a reason for hiding this comment

Uh oh!

jstac commented Sep 27, 2022

Uh oh!

HumphreyYang commented Sep 28, 2022

Uh oh!

mmcky commented Sep 28, 2022

Uh oh!

mmcky commented Sep 28, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

HumphreyYang commented Sep 10, 2022 •

edited

Loading

jstac Sep 27, 2022 •

edited

Loading