Skip to content
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

Explaining code formatting and including more links #1

Open
k8hertweck opened this issue Aug 25, 2020 · 0 comments
Open

Explaining code formatting and including more links #1

k8hertweck opened this issue Aug 25, 2020 · 0 comments

Comments

@k8hertweck
Copy link

Pointed to this repo by @jgolob , and want to offer the following recommendations based on my experience teaching folks new to Python:

  • explain what code comments are and why they are used here (e.g., why is some text in markdown cells and other text in commented lines?)
  • How and why do you split code onto separate lines (in the same cell)? This partially relates to your existing explanation of whitespace, and also relates to code that functions vs style issues.
  • I'm a huge fan of links to other resources. Off the top of my head, I'd include:
    • overview of Jupyter notebooks (shortcuts, how to use it, etc)
    • documentation for packages used (pandas, seaborn, etc)

Of course, these suggestions aren't essential for the material to work beautifully; I'm really glad to have this as an example for this type of analysis!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant