From 6a75d109794df2541f54abebddb80a3c070ab0f0 Mon Sep 17 00:00:00 2001 From: lf Date: Wed, 30 Oct 2019 21:56:59 -0700 Subject: [PATCH] [Docs] Fix dunder names being accidentally bolded (#7217) * Fix dunder names being accidentally bolded * Update docs/coding_conventions_python.md Co-Author: fauxpark * Change all the "names to avoid" to use backticks --- docs/coding_conventions_python.md | 6 +++--- 1 file 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