diff options
| author | lf <software@lfcode.ca> | 2019-10-30 21:56:59 -0700 |
|---|---|---|
| committer | noroadsleft <18669334+noroadsleft@users.noreply.github.com> | 2019-10-30 21:56:59 -0700 |
| commit | 6a75d109794df2541f54abebddb80a3c070ab0f0 (patch) | |
| tree | 23a34203d6da3f4f4a787787af7c6e987a28443f /docs/coding_conventions_python.md | |
| parent | 096a49c3dc3a1674a8cc95987c97e922c0c769a4 (diff) | |
| download | firmware-6a75d109794df2541f54abebddb80a3c070ab0f0.tar.gz firmware-6a75d109794df2541f54abebddb80a3c070ab0f0.tar.bz2 firmware-6a75d109794df2541f54abebddb80a3c070ab0f0.zip | |
[Docs] Fix dunder names being accidentally bolded (#7217)
* Fix dunder names being accidentally bolded
* Update docs/coding_conventions_python.md
Co-Author: fauxpark <fauxpark@gmail.com>
* Change all the "names to avoid" to use backticks
Diffstat (limited to 'docs/coding_conventions_python.md')
| -rw-r--r-- | docs/coding_conventions_python.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/coding_conventions_python.md b/docs/coding_conventions_python.md index c7743050e..694aa38cf 100644 --- a/docs/coding_conventions_python.md +++ b/docs/coding_conventions_python.md @@ -77,9 +77,9 @@ Always use a .py filename extension. Never use dashes. ## Names to Avoid -* single character names except for counters or iterators. You may use "e" as an exception identifier in try/except statements. -* dashes (-) in any package/module name -* __double_leading_and_trailing_underscore__ names (reserved by Python) +* single character names except for counters or iterators. You may use `e` as an exception identifier in try/except statements. +* dashes (`-`) in any package/module name +* `__double_leading_and_trailing_underscore__` names (reserved by Python) # Docstrings |