Update docstring

tammy-baylis-swi · Oct 17, 2024 · 690bc9a · 690bc9a
1 parent 408dc1b
commit 690bc9a
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/...entelemetry-instrumentation-pymysql/src/opentelemetry/instrumentation/pymysql/__init__.py b/...entelemetry-instrumentation-pymysql/src/opentelemetry/instrumentation/pymysql/__init__.py
@@ -26,7 +26,6 @@
     import pymysql
     from opentelemetry.instrumentation.pymysql import PyMySQLInstrumentor
 
-
     PyMySQLInstrumentor().instrument()
 
     cnx = pymysql.connect(database="MySQL_Database")
@@ -41,6 +40,9 @@
 You can optionally configure PyMySQL instrumentation to enable sqlcommenter which enriches
 the query with contextual information.
 
+Usage
+-----
+
 .. code:: python
 
     import MySQLdb
@@ -55,11 +57,14 @@
     cursor.close()
     cnx.close()
 
+
 For example,
 ::
+
    Invoking cursor.execute("INSERT INTO test (testField) VALUES (123)") will lead to sql query "INSERT INTO test (testField) VALUES (123)" but when SQLCommenter is enabled
    the query will get appended with some configurable tags like "INSERT INTO test (testField) VALUES (123) /*tag=value*/;"
 
+
 SQLCommenter Configurations
 ***************************
 We can configure the tags to be appended to the sqlquery log by adding configuration inside commenter_options(default:{}) keyword