Closed martinosorb closed 11 months ago
Thank you for your pull request :smiley:
:robot: 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:
:mag: Inspect the changes: https://github.com/swcarpentry/python-novice-gapminder/compare/md-outputs..md-outputs-PR-656
The following changes were observed in the rendered markdown documents:
18-style.md | 8 ++++++++
md5sum.txt | 2 +-
2 files changed, 9 insertions(+), 1 deletion(-)
:stopwatch: Updated at 2023-07-29 00:59:09 +0000
Ok, I followed your suggestion with a minor addition:
Use comments to describe and help others understand potentially unintuitive
sections or individual lines of code. They are especially useful to whoever may
need to edit your code in the future, including yourself.
Use docstrings to document the expected inputs and outputs of a method or class,
its purpose, assumptions and intended behavior. Docstrings are displayed
when a user invokes the builtin `help` method on your method or class.
This is meant to fix #464 but I'd love some feedback on how to succinctly describe the difference in use between comments and docstrings.