Feedback fixes #25
Feedback fixes #25
Conversation
Thank you!Thank you for your pull request 😃 🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}. If you have files that automatically render output (e.g. R Markdown), then you should check for the following:
Rendered Changes🔍 Inspect the changes: https://github.com/christopher-wild/FAIR4RS-Packaging/compare/md-outputs..md-outputs-PR-25 The following changes were observed in the rendered markdown documents: What does this mean?If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation. ⏱️ Updated at 2024-09-30 10:05:51 +0000 |
episodes/package-file-history.Rmd
Outdated
|
|
||
| ::: keypoints | ||
| - pyproject.toml files are the current recommended packaging file for Python | ||
| - other standards are still used and you may come across them | ||
| ::: |
There was a problem hiding this comment.
I think the key points here can be better summarised that align with the episode's questions/learning objectives
| ::: callout | ||
| You may notice a wheel file download during the pip install, for example `Downloading numpy-2.0.0-cp312-cp312-win_amd64.whl`. A wheel in Python is a prebuilt package format that allows for quicker and more efficient installation, so when it is downloaded your local computer doesn't need to do any building. The alternative is source files which often take the form `.zip` or `.tar.gz`, which when downloaded will then need to be built then installed, which is often far slower. | ||
|
|
||
| ::: | ||
|
|
||
| ::: challenge | ||
| ### Exercise 2: Create venv and install Numpy |
There was a problem hiding this comment.
The Windows/Mac tabs look absolutely massive here and in another one below! Might be because of the number of #?
There was a problem hiding this comment.
They do look commically big on yours! The amount of #'s is the same as the workbench recommends and looks okay on mine
.
There was a problem hiding this comment.
@christopher-wild that's strange! Never mind then!
|
|
||
| ::: instructor | ||
|
|
||
| The above command should be universal on both windows and mac/unix setups. It may be worth checking with the class at this point that they are all familiar with the -m notation, and what the above command does exactly | ||
| It may be worth checking with the class at this point that they are all familiar with the -m notation, and what the above command does exactly | ||
|
|
||
| ::: | ||
|
|
There was a problem hiding this comment.
Again I think the key points below can be made more informative
There was a problem hiding this comment.
@christopher-wild Sorry for the delay on this. I've left a few suggestions below.
Cheers for the helpful feedback, let me know if you think the new keypoints are any better 🙂 |
addresses feedback for episodes 2, 3 & 4
closes #17 closes #18 closes #19