-
Notifications
You must be signed in to change notification settings - Fork 1
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
Added lessons #1
base: main
Are you sure you want to change the base?
Conversation
Thanks for opening your first pull request here 🚀! If you have any questions, feel free to mention one of the conveners, previous contributors, or attend our weekly meeting (see |
for more information, see https://pre-commit.ci
The advantage of assertions is their ease of use. They are rarely more than one | ||
line of code. The disadvantage is that assertions halt execution | ||
indiscriminately and the helpfulness of the resulting error message is usually | ||
quite limited. |
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.
you can add custom error messages to them: assert False, "this will be displayed"
#FIXME | ||
## Setup Python | ||
|
||
Make sure that you have the latest Python installed. The latest Python released is `Python 3.11.3` |
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 explicit version adds maintenance burden. Use fixed link to the latest version, e.g. https://www.python.org/downloads/.
But this is also incorrect. We should not expect that this training only works with the latest python version. We should include a requirement that at least python 3.11 is needed, if that is the case.
```bash | ||
python –version | ||
``` | ||
- or if you have Python3: |
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.
Python 3.x is required for this training, and PEP 394 requires all Python 3.x to provide python3
, so I'd just write the test for only that command.
```bash | ||
python3 –version | ||
``` | ||
|
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'd refer to installation instructions at https://swcarpentry.github.io/python-novice-inflammation/#install-python instead of providing installation instructions here.
Added setup for the lesson
Additionally added instructions for Python3 (my case) just in case any student has the same issue running any code
Introduction
Erased most of the original info, and updated it. Used more technical language for it and added an image (gave link for the resource)
Assertions and Exceptions
Corrected some info + example
Added Exceptions on the episode
Small exercise needs to be fixed (more clear instructions?)
Its too long, probably I need to shorten the episode
Unit_Testing, Testing with Pytest and Fixtures
Fixed the import * on all of the code and changed the exercise to be instead of using Jupyter Notebooks, to do them using the terminal
Didn't do much on them, so probably also needs to be a little more cleaned
Thank you! <3