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

Add PEP 8 - Coding style and conventions for Python #52

Closed
DanielAzulayy opened this issue Aug 10, 2021 · 1 comment
Closed

Add PEP 8 - Coding style and conventions for Python #52

DanielAzulayy opened this issue Aug 10, 2021 · 1 comment

Comments

@DanielAzulayy
Copy link

DanielAzulayy commented Aug 10, 2021

** Suggestion. Sorry for opening an issue (and not a PR).

I believe it will be a great idea to add a new chapter for a coding style according to PEP 8.

Although some projects have their own coding style, it's still important to learn the basics of Python conventions so beginner's code will be much more cleaner and readable for others.

I know you used Python conventions during the course but I think there should be a new whole chapter for this to emphasize this topic.

@yammesicka
Copy link
Member

Thanks for bringing it up!
Sorry for the extended delay in answering the issue.
I have been planning the 3rd women course for a while now, and that is taking most of my time :)

I agree that aligning with PEP8 is a great thing to do, and it is unfortunate that we do not currently have any notebooks about it.
While writing a notebook regarding PEP8 is essential, I am afraid it is not currently on my top priority list.
Also, the first weeks are already super tight when thinking about the amount of material we are teaching, so I find it hard to think where it would practically fit in the syllabus.

Currently, my decision (and recommendation for teachers who uses my material) is to teach PEP8 through the code reviews.
Our lms code-checking system does that automatically.
For small classes and in-person education, I would recommend putting less stress on PEP8 when teaching students who have hard times getting started.

  • Yam

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

2 participants