summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorlf <software@lfcode.ca>2019-10-30 21:56:59 -0700
committernoroadsleft <18669334+noroadsleft@users.noreply.github.com>2019-10-30 21:56:59 -0700
commit6a75d109794df2541f54abebddb80a3c070ab0f0 (patch)
tree23a34203d6da3f4f4a787787af7c6e987a28443f /docs
parent096a49c3dc3a1674a8cc95987c97e922c0c769a4 (diff)
[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')
-rw-r--r--docs/coding_conventions_python.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/coding_conventions_python.md b/docs/coding_conventions_python.md
index c7743050e2..694aa38cfc 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