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

feat(lesson): pep8, linters & code formatters #12

Merged
merged 19 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions clean-modular-code/intro-clean-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,16 @@ jupyter:
name: python3
---

<!-- #region editable=true slideshow={"slide_type": ""} tags=["hide-content"] -->
<!-- #region editable=true slideshow={"slide_type": ""} -->
# Write Clean, Modular, DRY Code

:::{toctree}
:hidden:
:caption: Lessons
:maxdepth: 2

Intro <self>
Python Code Style <python-pep-8>
Package imports <pep8-package-imports>
Don't Repeat Yourself <python-dry-modular-code>
Functions <python-functions>
Function checks <python-function-checks>
Expand Down Expand Up @@ -56,10 +57,6 @@ Clean Code: Activity 2 <activity-2/clean-code-part-2>
Clean Code: Activity 3 <activity-3/clean-code-part-3>
:::

<!-- #endregion -->

<!-- #region editable=true slideshow={"slide_type": ""} -->
# Write Clean, Modular, DRY Code

:::{note}
After completing this lesson, you will be able to:
Expand All @@ -68,7 +65,7 @@ After completing this lesson, you will be able to:
* Apply the PEP 8 Style Guide standards to your **Python** code.
:::

"Pythonic" code is code that follows the conventions and best practices of the Python programming language. It emphasizes code that is clear, concise, and readable--principles that adhere to Python's design philosophy. <link to zen of python>
"Pythonic" code is code that follows the conventions and best practices of the Python programming language. It emphasizes code that is clear, concise, and readable--principles that adhere to Python's design philosophy.
lwasser marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Pythonic" code is code that follows the conventions and best practices of the Python programming language. It emphasizes code that is clear, concise, and readable--principles that adhere to Python's design philosophy.
"Pythonic" code is code that follows the conventions and best practices of the Python programming language. It emphasizes code that is clear, concise, and readable--principles that adhere to Python's design philosophy.[^zenofpython]

and at the bottom

[^zenofpython]: Paste this into your shell: `python -c 'import this'`


Pythonic code also takes full advantage of Python's features which include:

Expand Down
79 changes: 0 additions & 79 deletions clean-modular-code/pep8-package-imports.md

This file was deleted.

Loading
Loading