Commit 7cc6a7ab authored by goekce's avatar goekce
Browse files

clarifications

parent 20a04093
Pipeline #13214 passed with stage
in 6 minutes and 25 seconds
......@@ -540,7 +540,7 @@ What are some code styles recommendations for Python?
. . .
- four spaces instead of tabs. Tabs may save some characters, but are not recommended because the width of a tab may differ on different editors.
- four spaces instead of tabs. Tabs may save some characters, but are not recommended because the width of a tab may differ on different editors[^editor_responsible_for_converting_tab_to_spaces]
- blank lines
- between functions
- logical sections inside functions (`#TODO include an example`)
......@@ -548,3 +548,7 @@ What are some code styles recommendations for Python?
- commenting
- you do not have to comment everything. These may distract from actual code. Comment non-trivial things.
- put them on their own lines if possible
A convenient solution is to use a code linter that assists you with code style.
[^editor_responsible_for_converting_tab_to_spaces]: This does not mean that you have to type four spaces. Typically the code editor place four spaces automatically for you when you type a tab.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment