-
Notifications
You must be signed in to change notification settings - Fork 109
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
chore: port entire Part 1 / Intro to Python #245
Conversation
I have been going through more material and the content is not only more descriptive, but also arranged well. There is no instance of information being present in RSD course but absent from doctoral training course. I will port all the pages together so that no content is skipped in between PRs (given that the content will be rearranged a bit). |
f3a76a6
to
81d7e3c
Compare
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.
Since this is a long PR, I'm going to review file by file. Here some suggestions for 016functions
ch01python/016functions.ipynb.py
Outdated
# This is pretty awful style, in general, functions should normally be side-effect free. | ||
# | ||
# Here is a contrived example of a function that makes plausible use of a side-effect | ||
# |
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.
I'll probably leave that as to warn about the following example. But it needs some explanation around it like:
# Note that the function below we are using `[:]`. This is used to update the content of the list, and though this function is not returning anything, it's changing the elements of the list.
ch01python/016functions.ipynb.py
Outdated
# ## Early Return | ||
|
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 needs a comment about it. Could you at least write a comment with a TODO?
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.
second file reviewed!
It was easier to review and push the other files. I let you "fix" the first two ;) |
Co-authored-by: David Pérez-Suárez <d.perez-suarez@ucl.ac.uk>
Thanks for the review and fixing my mess, @dpshelio! 🔨 I have updated the PR with your suggestions. |
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.
Awesome!!! You've not messed anything 😉 . I'm going to add the small suggestions and merge it now. 🙌
and some extra content that made explanations clearer
XRef #238
Also closes #201