Code readability

Writing code so that the next person, often yourself months later, can quickly understand what it does and why: clear names, docstrings, comments that explain, one shared style.

Depth 1 · Foundation

You write code for its next reader: names that say what values are (units included), docstrings that say what a function is for, comments that say why rather than what, and PEP 8's shared style.

Depths of understanding

1
Foundation
You write code for its next reader: names that say what values are (units included), docstrings that say what a function is for, comments that say why rather than what, and PEP 8's shared style.
Opens after
Type annotationsA clear signature, with names and types, is the first thing a reader of your function sees.

Your path here

What's still between you and Code readability, depth 1, in the order you can learn it.

Where it fits

Builds on

Type annotations

This concept

Code readabilityWriting Correct Code

Builds onThis conceptType annotations Code readabilityWriting Correct Code