Skip to content

Wrote more on meaningful variable names #358

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.

Sign up for GitHub

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

Merged
anenadic merged 3 commits into from
Feb 4, 2026
Merged

Wrote more on meaningful variable names #358

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92585cf
Adding suggestions from issue 295 to close it
sstevens2 Dec 17, 2025
02c2752
Apply suggestions from code review
anenadic Feb 4, 2026
1ae1128
Update episodes/04-code-readability.md
anenadic Feb 4, 2026
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
4 changes: 3 additions & 1 deletion episodes/04-code-readability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,9 @@ to read and prone to misspellings. `ReadSpeed` (or `read_speed`) would suffice.
go with the short version and use an inline comment to describe it further (more on those in the next section).
This guidance does not necessarily apply if your variable is a well-known constant in your domain -
for example, *c* represents the speed of light in physics.
- Try to be descriptive where possible and avoid meaningless or funny names like `foo`, `bar`, `var`, `thing`, etc.
- Avoid overloading a variable (e.g. *f* could be Fahrenheit or for function or for file or something else)
- Try to be descriptive where possible and avoid meaningless or funny names like `foo`, `bar`, `var`, `thing`, etc. If possible, aim for "self-documenting" code, where the names are meaningful enough that you don't need comments to describe them.
- Avoid using references to cultural knowledge or popular culture or uncommon terms as this can confuse individuals who are not familiar with those references.

There are also some restrictions to consider when naming variables in Python:

Expand Down